API_Gateway.md

graph LR
    create_app["create_app"]
    register_routes["register_routes"]
    submit_scan_prompt["submit_scan_prompt"]
    submit_scan_output["submit_scan_output"]
    submit_analyze_prompt["submit_analyze_prompt"]
    create_app -- "initiates" --> register_routes
    register_routes -- "maps requests to" --> submit_scan_prompt
    register_routes -- "maps requests to" --> submit_scan_output
    register_routes -- "maps requests to" --> submit_analyze_prompt

Loading

Details

The API Gateway subsystem serves as the primary external interface for the LLM Guard system, handling all incoming scan and analysis requests.

create_app

Initializes the FastAPI application, orchestrates the setup of scanners, and registers all API routes. It serves as the main entry point for the API.

Related Classes/Methods:

• llm_guard_api.app.app.register_routes:162-495
• llm_guard_api.app.scanner._get_input_scanners_function
• llm_guard_api.app.scanner._get_output_scanners_function

register_routes

Defines and registers the various API endpoints (e.g., /scan/prompt, /scan/output, /analyze/prompt) with their respective handler functions. It also integrates authentication mechanisms.

Related Classes/Methods:

• llm_guard_api.app.app.submit_scan_prompt:398-460
• llm_guard_api.app.app.submit_scan_output:265-333
• llm_guard_api.app.app.submit_analyze_prompt:335-396
• llm_guard_api.app.app._check_auth_function:91-123

submit_scan_prompt

Serves as the API endpoint handler for receiving and processing requests to scan user prompts. It delegates the actual scanning to the core scanner engine.

Related Classes/Methods:

• llm_guard_api.app.scanner.ascan_prompt:303-304
• llm_guard_api.app.schemas.ScanPromptResponse:11-13

submit_scan_output

Serves as the API endpoint handler for receiving and processing requests to scan LLM-generated outputs. It delegates the actual scanning to the core scanner engine.

Related Classes/Methods:

• llm_guard_api.app.scanner.ascan_output:328-329
• llm_guard_api.app.schemas.ScanOutputResponse:30-32

submit_analyze_prompt

Serves as the API endpoint handler for requests related to prompt analysis.

Related Classes/Methods:

• llm_guard_api.app.schemas.AnalyzePromptResponse:20-21

FAQ