api package

Submodules

api.exam_api module

FastAPI router for medical exam generation endpoints.

This module defines the API routes for generating laboratory exam results based on a given clinical scenario. It provides an endpoint to create a structured set of lab results.

Version: 1.2

api.exam_api.generate_exams_endpoint(request: LabExamRequest) → LabExamResponse

Generates a set of lab results based on a clinical scenario.

This endpoint receives a scenario description and generates a corresponding set of lab results, including a textual interpretation for each test.

Parameters:

request – A request object containing the clinical scenario description and patient type.

Returns:

A response object containing the generated laboratory exams.

api.mat_api module

FastAPI router for medical material generation endpoints.

This module defines the API routes for generating necessary materials for a given medical simulation scenario. It includes an endpoint for generating a list of materials and another for retrieving available patient types.

api.mat_api.generate_materials_endpoint(request: MATModelRequest) → List[MATModelResponse]

Generates a list of necessary materials for a medical simulation.

api.mat_api.get_form_options() → Dict[str, List[str]]

Retrieves the lists of available patient types dynamically from the request model to populate frontend selection inputs. The ‘target’ field is a free-text string and is not included here.

api.medical_report_api module

FastAPI router for medical report generation endpoints.

This module defines the API routes for generating and managing medical reports. It provides endpoints for creating a report based on a clinical scenario and for retrieving the list of supported examination and patient types.

Version: 1.1

api.medical_report_api.generate_medical_report_endpoint(request: MedicalReportRequest) → MedicalReportResponse

Generates a medical report for a specific examination.

This endpoint takes a detailed clinical scenario and generates a formal medical report for the specified examination type.

Parameters:

request – A request object containing the scenario description, patient type, and the type of examination to report on.

Returns:

A response object containing the generated medical report.

api.medical_report_api.get_exam_types() → Dict[str, List[str]]

Retrieves the lists of available examination and patient types dynamically from the request model.

api.scenario_api module

FastAPI router for medical scenario generation endpoints.

This module defines the API routes related to creating and managing medical simulation scenarios. It includes endpoints for generating full scenarios based on user-defined parameters and for retrieving available difficulty levels.

Version: 4.3

api.scenario_api.generate_scenario_endpoint(request: ScenarioRequest) → FullScenario

Generates a complete medical scenario based on user specifications.

This endpoint receives a request detailing the desired scenario and passes it to the scenario generation agent, which returns a fully structured scenario object.

Parameters:

request – An object containing the description, type, target audience, and difficulty level for the scenario.

Returns:

A complete, structured medical scenario object.

api.scenario_api.get_difficulty_levels() → Dict[str, Any]

Retrieves the available difficulty levels for scenario generation.

Module contents

API package for the Medical Simulation Suite AI.

This package aggregates all the FastAPI routers from the various sub-modules, making them available for inclusion in the main application. The __all__ variable explicitly defines the public API of this package.