qfa.api.routes#

API route handlers for the feedback analysis backend.

Functions

analyze(body, request, tenant, orchestrator)

Analyze a batch of feedback records.

assign_codes(body, tenant, orchestrator)

Assign codes via iterative LLM picks at each level of the framework.

health()

Return service health status.

summarize(body, request, tenant, orchestrator)

Summarize each submitted feedback record individually.

summarize_aggregate(body, request, tenant, ...)

Summarize all submitted feedback records as a single aggregate summary.
async qfa.api.routes.analyze(body: ApiAnalyzeRequest, request: Request, tenant: TenantApiKey = Depends(dependency=<function authenticate_request>, use_cache=True, scope=None), orchestrator: Orchestrator = Depends(dependency=<function get_orchestrator>, use_cache=True, scope=None)) → ApiAnalyzeResponse[source]#

Analyze a batch of feedback records.

Parameters:

  • body (AnalyzeRequest) – The request body containing feedback records and prompt.

  • request (Request) – The incoming HTTP request.

  • tenant (TenantApiKey) – The authenticated tenant, injected via dependency.

  • orchestrator (Orchestrator) – The orchestrator service, injected via dependency.

Returns:

The analysis result with feedback record count and request ID.

Return type:

AnalyzeResponse

async qfa.api.routes.summarize(body: ApiSummarizeRequest, request: Request, tenant: TenantApiKey = Depends(dependency=<function authenticate_request>, use_cache=True, scope=None), orchestrator: Orchestrator = Depends(dependency=<function get_orchestrator>, use_cache=True, scope=None)) → ApiSummarizeResponse[source]#

Summarize each submitted feedback record individually.

Parameters:

  • body (SummarizeRequest) – The request body containing feedback records and summarization options.

  • request (Request) – The incoming HTTP request.

  • tenant (TenantApiKey) – The authenticated tenant, injected via dependency.

  • orchestrator (Orchestrator) – The orchestrator service, injected via dependency.

Returns:

The per-feedback-record titles and summaries.

Return type:

SummarizeResponse

async qfa.api.routes.assign_codes(body: ApiAssignCodesRequest, tenant: TenantApiKey = Depends(dependency=<function authenticate_request>, use_cache=True, scope=None), orchestrator: Orchestrator = Depends(dependency=<function get_orchestrator>, use_cache=True, scope=None)) → ApiAssignCodesResponse[source]#

Assign codes via iterative LLM picks at each level of the framework.

async qfa.api.routes.summarize_aggregate(body: ApiSummarizeRequest, request: Request, tenant: TenantApiKey = Depends(dependency=<function authenticate_request>, use_cache=True, scope=None), orchestrator: Orchestrator = Depends(dependency=<function get_orchestrator>, use_cache=True, scope=None)) → ApiSummarizeAggregateResponse[source]#

Summarize all submitted feedback records as a single aggregate summary.

Parameters:

  • body (SummarizeRequest) – The request body containing feedback records and summarization options.

  • request (Request) – The incoming HTTP request.

  • tenant (TenantApiKey) – The authenticated tenant, injected via dependency.

  • orchestrator (Orchestrator) – The orchestrator service, injected via dependency.

Returns:

A single summary with themes ordered by frequency across all feedback records.

Return type:

SummarizeAggregateResponse

async qfa.api.routes.health() → ApiHealthResponse[source]#

Return service health status.

Returns:

Health status and package version.

Return type:

HealthResponse