openapi: 3.1.0 info: title: Llama Stack Specification - Stable & Experimental APIs description: |- This is the specification of the Llama Stack that provides a set of endpoints and their corresponding interfaces that are tailored to best leverage Llama Models. **🔗 COMBINED**: This specification includes both stable production-ready APIs and experimental pre-release APIs. Use stable APIs for production deployments and experimental APIs for testing new features. version: v1 servers: - url: http://any-hosted-llama-stack.com paths: /v1/providers/{provider_id}: get: tags: - Providers summary: Inspect Provider operationId: inspect_provider_v1_providers__provider_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: provider_id in: path required: true schema: type: string description: 'Path parameter: provider_id' /v1/providers: get: tags: - Providers summary: List Providers operationId: list_providers_v1_providers_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/responses: get: tags: - Agents summary: List Openai Responses operationId: list_openai_responses_v1_responses_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Agents summary: Create Openai Response operationId: create_openai_response_v1_responses_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/responses/{response_id}: get: tags: - Agents summary: Get Openai Response operationId: get_openai_response_v1_responses__response_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' delete: tags: - Agents summary: Delete Openai Response operationId: delete_openai_response_v1_responses__response_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' /v1/responses/{response_id}/input_items: get: tags: - Agents summary: List Openai Response Input Items operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' /v1/chat/completions/{completion_id}: get: tags: - Inference summary: Get Chat Completion operationId: get_chat_completion_v1_chat_completions__completion_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: completion_id in: path required: true schema: type: string description: 'Path parameter: completion_id' /v1/chat/completions: get: tags: - Inference summary: List Chat Completions operationId: list_chat_completions_v1_chat_completions_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Inference summary: Openai Chat Completion operationId: openai_chat_completion_v1_chat_completions_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/completions: post: tags: - Inference summary: Openai Completion operationId: openai_completion_v1_completions_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/embeddings: post: tags: - Inference summary: Openai Embeddings operationId: openai_embeddings_v1_embeddings_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1alpha/inference/rerank: post: tags: - Inference summary: Rerank operationId: rerank_v1alpha_inference_rerank_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/health: get: tags: - Inspect summary: Health operationId: health_v1_health_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/inspect/routes: get: tags: - Inspect summary: List Routes operationId: list_routes_v1_inspect_routes_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/version: get: tags: - Inspect summary: Version operationId: version_v1_version_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/batches/{batch_id}/cancel: post: tags: - Batches summary: Cancel Batch operationId: cancel_batch_v1_batches__batch_id__cancel_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: batch_id in: path required: true schema: type: string description: 'Path parameter: batch_id' /v1/batches: get: tags: - Batches summary: List Batches operationId: list_batches_v1_batches_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Batches summary: Create Batch operationId: create_batch_v1_batches_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/batches/{batch_id}: get: tags: - Batches summary: Retrieve Batch operationId: retrieve_batch_v1_batches__batch_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: batch_id in: path required: true schema: type: string description: 'Path parameter: batch_id' /v1/vector-io/insert: post: tags: - Vector Io summary: Insert Chunks operationId: insert_chunks_v1_vector_io_insert_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/files: get: tags: - Vector Io summary: Openai List Files In Vector Store operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' post: tags: - Vector Io summary: Openai Attach File To Vector Store operationId: openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: post: tags: - Vector Io summary: Openai Cancel Vector Store File Batch operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: batch_id in: path required: true schema: type: string description: 'Path parameter: batch_id' /v1/vector_stores: get: tags: - Vector Io summary: Openai List Vector Stores operationId: openai_list_vector_stores_v1_vector_stores_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Vector Io summary: Openai Create Vector Store operationId: openai_create_vector_store_v1_vector_stores_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/file_batches: post: tags: - Vector Io summary: Openai Create Vector Store File Batch operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' /v1/vector_stores/{vector_store_id}: get: tags: - Vector Io summary: Openai Retrieve Vector Store operationId: openai_retrieve_vector_store_v1_vector_stores__vector_store_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' post: tags: - Vector Io summary: Openai Update Vector Store operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' delete: tags: - Vector Io summary: Openai Delete Vector Store operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' /v1/vector_stores/{vector_store_id}/files/{file_id}: get: tags: - Vector Io summary: Openai Retrieve Vector Store File operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' post: tags: - Vector Io summary: Openai Update Vector Store File operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' delete: tags: - Vector Io summary: Openai Delete Vector Store File operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files: get: tags: - Vector Io summary: Openai List Files In Vector Store File Batch operationId: openai_list_files_in_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: batch_id in: path required: true schema: type: string description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}: get: tags: - Vector Io summary: Openai Retrieve Vector Store File Batch operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: batch_id in: path required: true schema: type: string description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: tags: - Vector Io summary: Openai Retrieve Vector Store File Contents operationId: openai_retrieve_vector_store_file_contents_v1_vector_stores__vector_store_id__files__file_id__content_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' /v1/vector_stores/{vector_store_id}/search: post: tags: - Vector Io summary: Openai Search Vector Store operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' /v1/vector-io/query: post: tags: - Vector Io summary: Query Chunks operationId: query_chunks_v1_vector_io_query_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/models/{model_id}: get: tags: - Models summary: Get Model operationId: get_model_v1_models__model_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: model_id in: path required: true schema: type: string description: 'Path parameter: model_id' delete: tags: - Models summary: Unregister Model operationId: unregister_model_v1_models__model_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true parameters: - name: model_id in: path required: true schema: type: string description: 'Path parameter: model_id' /v1/models: get: tags: - Models summary: Openai List Models operationId: openai_list_models_v1_models_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Models summary: Register Model operationId: register_model_v1_models_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true /v1/moderations: post: tags: - Safety summary: Run Moderation operationId: run_moderation_v1_moderations_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/safety/run-shield: post: tags: - Safety summary: Run Shield operationId: run_shield_v1_safety_run_shield_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/shields/{identifier}: get: tags: - Shields summary: Get Shield operationId: get_shield_v1_shields__identifier__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: identifier in: path required: true schema: type: string description: 'Path parameter: identifier' delete: tags: - Shields summary: Unregister Shield operationId: unregister_shield_v1_shields__identifier__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true parameters: - name: identifier in: path required: true schema: type: string description: 'Path parameter: identifier' /v1/shields: get: tags: - Shields summary: List Shields operationId: list_shields_v1_shields_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Shields summary: Register Shield operationId: register_shield_v1_shields_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true /v1beta/datasetio/append-rows/{dataset_id}: post: tags: - Datasetio summary: Append Rows operationId: append_rows_v1beta_datasetio_append_rows__dataset_id__post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' /v1beta/datasetio/iterrows/{dataset_id}: get: tags: - Datasetio summary: Iterrows operationId: iterrows_v1beta_datasetio_iterrows__dataset_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' /v1beta/datasets/{dataset_id}: get: tags: - Datasets summary: Get Dataset operationId: get_dataset_v1beta_datasets__dataset_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' delete: tags: - Datasets summary: Unregister Dataset operationId: unregister_dataset_v1beta_datasets__dataset_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true parameters: - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' /v1beta/datasets: get: tags: - Datasets summary: List Datasets operationId: list_datasets_v1beta_datasets_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Datasets summary: Register Dataset operationId: register_dataset_v1beta_datasets_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true /v1/scoring/score: post: tags: - Scoring summary: Score operationId: score_v1_scoring_score_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/scoring/score-batch: post: tags: - Scoring summary: Score Batch operationId: score_batch_v1_scoring_score_batch_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/scoring-functions/{scoring_fn_id}: get: tags: - Scoring Functions summary: Get Scoring Function operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: scoring_fn_id in: path required: true schema: type: string description: 'Path parameter: scoring_fn_id' delete: tags: - Scoring Functions summary: Unregister Scoring Function operationId: unregister_scoring_function_v1_scoring_functions__scoring_fn_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true parameters: - name: scoring_fn_id in: path required: true schema: type: string description: 'Path parameter: scoring_fn_id' /v1/scoring-functions: get: tags: - Scoring Functions summary: List Scoring Functions operationId: list_scoring_functions_v1_scoring_functions_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Scoring Functions summary: Register Scoring Function operationId: register_scoring_function_v1_scoring_functions_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: post: tags: - Eval summary: Evaluate Rows operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' /v1alpha/eval/benchmarks/{benchmark_id}/jobs/{job_id}: get: tags: - Eval summary: Job Status operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' - name: job_id in: path required: true schema: type: string description: 'Path parameter: job_id' delete: tags: - Eval summary: Job Cancel operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' - name: job_id in: path required: true schema: type: string description: 'Path parameter: job_id' /v1alpha/eval/benchmarks/{benchmark_id}/jobs/{job_id}/result: get: tags: - Eval summary: Job Result operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' - name: job_id in: path required: true schema: type: string description: 'Path parameter: job_id' /v1alpha/eval/benchmarks/{benchmark_id}/jobs: post: tags: - Eval summary: Run Eval operationId: run_eval_v1alpha_eval_benchmarks__benchmark_id__jobs_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' /v1alpha/eval/benchmarks/{benchmark_id}: get: tags: - Benchmarks summary: Get Benchmark operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' delete: tags: - Benchmarks summary: Unregister Benchmark operationId: unregister_benchmark_v1alpha_eval_benchmarks__benchmark_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true parameters: - name: benchmark_id in: path required: true schema: type: string description: 'Path parameter: benchmark_id' /v1alpha/eval/benchmarks: get: tags: - Benchmarks summary: List Benchmarks operationId: list_benchmarks_v1alpha_eval_benchmarks_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Benchmarks summary: Register Benchmark operationId: register_benchmark_v1alpha_eval_benchmarks_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true /v1alpha/post-training/job/cancel: post: tags: - Post Training summary: Cancel Training Job operationId: cancel_training_job_v1alpha_post_training_job_cancel_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/artifacts: get: tags: - Post Training summary: Get Training Job Artifacts operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/status: get: tags: - Post Training summary: Get Training Job Status operationId: get_training_job_status_v1alpha_post_training_job_status_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1alpha/post-training/jobs: get: tags: - Post Training summary: Get Training Jobs operationId: get_training_jobs_v1alpha_post_training_jobs_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1alpha/post-training/preference-optimize: post: tags: - Post Training summary: Preference Optimize operationId: preference_optimize_v1alpha_post_training_preference_optimize_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1alpha/post-training/supervised-fine-tune: post: tags: - Post Training summary: Supervised Fine Tune operationId: supervised_fine_tune_v1alpha_post_training_supervised_fine_tune_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/tools/{tool_name}: get: tags: - Tool Groups summary: Get Tool operationId: get_tool_v1_tools__tool_name__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: tool_name in: path required: true schema: type: string description: 'Path parameter: tool_name' /v1/toolgroups/{toolgroup_id}: get: tags: - Tool Groups summary: Get Tool Group operationId: get_tool_group_v1_toolgroups__toolgroup_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: toolgroup_id in: path required: true schema: type: string description: 'Path parameter: toolgroup_id' delete: tags: - Tool Groups summary: Unregister Toolgroup operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true parameters: - name: toolgroup_id in: path required: true schema: type: string description: 'Path parameter: toolgroup_id' /v1/toolgroups: get: tags: - Tool Groups summary: List Tool Groups operationId: list_tool_groups_v1_toolgroups_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Tool Groups summary: Register Tool Group operationId: register_tool_group_v1_toolgroups_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' deprecated: true /v1/tools: get: tags: - Tool Groups summary: List Tools operationId: list_tools_v1_tools_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/tool-runtime/invoke: post: tags: - Tool Runtime summary: Invoke Tool operationId: invoke_tool_v1_tool_runtime_invoke_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/tool-runtime/list-tools: get: tags: - Tool Runtime summary: List Runtime Tools operationId: list_runtime_tools_v1_tool_runtime_list_tools_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/files/{file_id}: get: tags: - Files summary: Openai Retrieve File operationId: openai_retrieve_file_v1_files__file_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' delete: tags: - Files summary: Openai Delete File operationId: openai_delete_file_v1_files__file_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' /v1/files: get: tags: - Files summary: Openai List Files operationId: openai_list_files_v1_files_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Files summary: Openai Upload File operationId: openai_upload_file_v1_files_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/files/{file_id}/content: get: tags: - Files summary: Openai Retrieve File Content operationId: openai_retrieve_file_content_v1_files__file_id__content_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: file_id in: path required: true schema: type: string description: 'Path parameter: file_id' /v1/prompts: get: tags: - Prompts summary: List Prompts operationId: list_prompts_v1_prompts_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' post: tags: - Prompts summary: Create Prompt operationId: create_prompt_v1_prompts_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/prompts/{prompt_id}: get: tags: - Prompts summary: Get Prompt operationId: get_prompt_v1_prompts__prompt_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' post: tags: - Prompts summary: Update Prompt operationId: update_prompt_v1_prompts__prompt_id__post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' delete: tags: - Prompts summary: Delete Prompt operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' /v1/prompts/{prompt_id}/versions: get: tags: - Prompts summary: List Prompt Versions operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' /v1/prompts/{prompt_id}/set-default-version: post: tags: - Prompts summary: Set Default Version operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' /v1/conversations/{conversation_id}/items: get: tags: - Conversations summary: List Items operationId: list_items_v1_conversations__conversation_id__items_get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' post: tags: - Conversations summary: Add Items operationId: add_items_v1_conversations__conversation_id__items_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' /v1/conversations: post: tags: - Conversations summary: Create Conversation operationId: create_conversation_v1_conversations_post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' /v1/conversations/{conversation_id}: get: tags: - Conversations summary: Get Conversation operationId: get_conversation_v1_conversations__conversation_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' post: tags: - Conversations summary: Update Conversation operationId: update_conversation_v1_conversations__conversation_id__post responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' delete: tags: - Conversations summary: Openai Delete Conversation operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' /v1/conversations/{conversation_id}/items/{item_id}: get: tags: - Conversations summary: Retrieve operationId: retrieve_v1_conversations__conversation_id__items__item_id__get responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' - name: item_id in: path required: true schema: type: string description: 'Path parameter: item_id' delete: tags: - Conversations summary: Openai Delete Conversation Item operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete responses: '200': description: Successful Response content: application/json: schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' - name: item_id in: path required: true schema: type: string description: 'Path parameter: item_id' components: responses: BadRequest400: description: The request was invalid or malformed content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 400 title: Bad Request detail: The request was invalid or malformed TooManyRequests429: description: The client has sent too many requests in a given amount of time content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 429 title: Too Many Requests detail: You have exceeded the rate limit. Please try again later. InternalServerError500: description: The server encountered an unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 500 title: Internal Server Error detail: An unexpected error occurred DefaultError: description: An error occurred content: application/json: schema: $ref: '#/components/schemas/Error' schemas: ImageContentItem: description: A image content item properties: type: const: image default: image title: Type type: string image: $ref: '#/components/schemas/_URLOrData' required: - image title: ImageContentItem type: object TextContentItem: description: A text content item properties: type: const: text default: text title: Type type: string text: title: Text type: string required: - text title: TextContentItem type: object URL: description: A URL reference to external content. properties: uri: title: Uri type: string required: - uri title: URL type: object _URLOrData: description: A URL or a base64 encoded string properties: url: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' nullable: true title: URL data: anyOf: - type: string - type: 'null' contentEncoding: base64 nullable: true title: _URLOrData type: object InterleavedContentItem: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem InterleavedContent: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] GreedySamplingStrategy: description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: const: greedy default: greedy title: Type type: string title: GreedySamplingStrategy type: object TopKSamplingStrategy: description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: const: top_k default: top_k title: Type type: string top_k: minimum: 1 title: Top K type: integer required: - top_k title: TopKSamplingStrategy type: object TopPSamplingStrategy: description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: type: const: top_p default: top_p title: Type type: string temperature: anyOf: - type: number minimum: 0.0 - type: 'null' top_p: anyOf: - type: number - type: 'null' default: 0.95 required: - temperature title: TopPSamplingStrategy type: object SamplingStrategy: discriminator: mapping: greedy: '#/components/schemas/GreedySamplingStrategy' top_k: '#/components/schemas/TopKSamplingStrategy' top_p: '#/components/schemas/TopPSamplingStrategy' propertyName: type oneOf: - $ref: '#/components/schemas/GreedySamplingStrategy' title: GreedySamplingStrategy - $ref: '#/components/schemas/TopPSamplingStrategy' title: TopPSamplingStrategy - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy GrammarResponseFormat: description: Configuration for grammar-guided response generation. properties: type: const: grammar default: grammar title: Type type: string bnf: additionalProperties: true title: Bnf type: object required: - bnf title: GrammarResponseFormat type: object JsonSchemaResponseFormat: description: Configuration for JSON schema-guided response generation. properties: type: const: json_schema default: json_schema title: Type type: string json_schema: additionalProperties: true title: Json Schema type: object required: - json_schema title: JsonSchemaResponseFormat type: object ResponseFormat: discriminator: mapping: grammar: '#/components/schemas/GrammarResponseFormat' json_schema: '#/components/schemas/JsonSchemaResponseFormat' propertyName: type oneOf: - $ref: '#/components/schemas/JsonSchemaResponseFormat' title: JsonSchemaResponseFormat - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat OpenAIChatCompletionContentPartImageParam: description: Image content part for OpenAI-compatible chat completion messages. properties: type: const: image_url default: image_url title: Type type: string image_url: $ref: '#/components/schemas/OpenAIImageURL' required: - image_url title: OpenAIChatCompletionContentPartImageParam type: object OpenAIChatCompletionContentPartTextParam: description: Text content part for OpenAI-compatible chat completion messages. properties: type: const: text default: text title: Type type: string text: title: Text type: string required: - text title: OpenAIChatCompletionContentPartTextParam type: object OpenAIFile: properties: type: const: file default: file title: Type type: string file: $ref: '#/components/schemas/OpenAIFileFile' required: - file title: OpenAIFile type: object OpenAIFileFile: properties: file_data: anyOf: - type: string - type: 'null' nullable: true file_id: anyOf: - type: string - type: 'null' nullable: true filename: anyOf: - type: string - type: 'null' nullable: true title: OpenAIFileFile type: object OpenAIImageURL: description: Image URL specification for OpenAI-compatible chat completion messages. properties: url: title: Url type: string detail: anyOf: - type: string - type: 'null' nullable: true required: - url title: OpenAIImageURL type: object OpenAIChatCompletionContentPartParam: discriminator: mapping: file: '#/components/schemas/OpenAIFile' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam - $ref: '#/components/schemas/OpenAIFile' title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: role: const: assistant default: assistant title: Role type: string content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] - type: 'null' title: string | list[OpenAIChatCompletionContentPartTextParam] nullable: true name: anyOf: - type: string - type: 'null' nullable: true tool_calls: anyOf: - items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' type: array - type: 'null' nullable: true title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionToolCall: description: Tool call specification for OpenAI-compatible chat completion responses. properties: index: anyOf: - type: integer - type: 'null' nullable: true id: anyOf: - type: string - type: 'null' nullable: true type: const: function default: function title: Type type: string function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' nullable: true title: OpenAIChatCompletionToolCallFunction title: OpenAIChatCompletionToolCall type: object OpenAIChatCompletionToolCallFunction: description: Function call details for OpenAI-compatible tool calls. properties: name: anyOf: - type: string - type: 'null' nullable: true arguments: anyOf: - type: string - type: 'null' nullable: true title: OpenAIChatCompletionToolCallFunction type: object OpenAIDeveloperMessageParam: description: A message from the developer in an OpenAI-compatible chat completion request. properties: role: const: developer default: developer title: Role type: string content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] name: anyOf: - type: string - type: 'null' nullable: true required: - content title: OpenAIDeveloperMessageParam type: object OpenAISystemMessageParam: description: A system message providing instructions or context to the model. properties: role: const: system default: system title: Role type: string content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] name: anyOf: - type: string - type: 'null' nullable: true required: - content title: OpenAISystemMessageParam type: object OpenAIToolMessageParam: description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. properties: role: const: tool default: tool title: Role type: string tool_call_id: title: Tool Call Id type: string content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] required: - tool_call_id - content title: OpenAIToolMessageParam type: object OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: role: const: user default: user title: Role type: string content: anyOf: - type: string - items: discriminator: mapping: file: '#/components/schemas/OpenAIFile' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam - $ref: '#/components/schemas/OpenAIFile' title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile type: array title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] name: anyOf: - type: string - type: 'null' nullable: true required: - content title: OpenAIUserMessageParam type: object OpenAIMessageParam: discriminator: mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' propertyName: role oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam' title: OpenAIAssistantMessageParam - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAIJSONSchema: description: JSON schema specification for OpenAI-compatible structured response format. properties: name: title: Name type: string description: anyOf: - type: string - type: 'null' strict: anyOf: - type: boolean - type: 'null' schema: anyOf: - additionalProperties: true type: object - type: 'null' title: OpenAIJSONSchema type: object OpenAIResponseFormatJSONObject: description: JSON object response format for OpenAI-compatible chat completion requests. properties: type: const: json_object default: json_object title: Type type: string title: OpenAIResponseFormatJSONObject type: object OpenAIResponseFormatJSONSchema: description: JSON schema response format for OpenAI-compatible chat completion requests. properties: type: const: json_schema default: json_schema title: Type type: string json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' required: - json_schema title: OpenAIResponseFormatJSONSchema type: object OpenAIResponseFormatText: description: Text response format for OpenAI-compatible chat completion requests. properties: type: const: text default: text title: Type type: string title: OpenAIResponseFormatText type: object OpenAIResponseFormatParam: discriminator: mapping: json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' text: '#/components/schemas/OpenAIResponseFormatText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject VectorStoreChunkingStrategyAuto: description: Automatic chunking strategy for vector store files. properties: type: const: auto default: auto title: Type type: string title: VectorStoreChunkingStrategyAuto type: object VectorStoreChunkingStrategyStatic: description: Static chunking strategy with configurable parameters. properties: type: const: static default: static title: Type type: string static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' required: - static title: VectorStoreChunkingStrategyStatic type: object VectorStoreChunkingStrategyStaticConfig: description: Configuration for static chunking strategy. properties: chunk_overlap_tokens: default: 400 title: Chunk Overlap Tokens type: integer max_chunk_size_tokens: default: 800 maximum: 4096 minimum: 100 title: Max Chunk Size Tokens type: integer title: VectorStoreChunkingStrategyStaticConfig type: object VectorStoreChunkingStrategy: discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreFileStatus: type: string enum: - completed - in_progress - cancelled - failed default: completed OpenAIResponseInputMessageContentFile: description: File content for input messages in OpenAI response format. properties: type: const: input_file default: input_file title: Type type: string file_data: anyOf: - type: string - type: 'null' nullable: true file_id: anyOf: - type: string - type: 'null' nullable: true file_url: anyOf: - type: string - type: 'null' nullable: true filename: anyOf: - type: string - type: 'null' nullable: true title: OpenAIResponseInputMessageContentFile type: object OpenAIResponseInputMessageContentImage: description: Image content for input messages in OpenAI response format. properties: detail: default: auto title: Detail type: string enum: - low - high - auto type: const: input_image default: input_image title: Type type: string file_id: anyOf: - type: string - type: 'null' nullable: true image_url: anyOf: - type: string - type: 'null' nullable: true title: OpenAIResponseInputMessageContentImage type: object OpenAIResponseInputMessageContentText: description: Text content for input messages in OpenAI response format. properties: text: title: Text type: string type: const: input_text default: input_text title: Type type: string required: - text title: OpenAIResponseInputMessageContentText type: object OpenAIResponseInputMessageContent: discriminator: mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseAnnotationCitation: description: URL citation annotation for referencing external web resources. properties: type: const: url_citation default: url_citation title: Type type: string end_index: title: End Index type: integer start_index: title: Start Index type: integer title: title: Title type: string url: title: Url type: string required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation type: object OpenAIResponseAnnotationContainerFileCitation: properties: type: const: container_file_citation default: container_file_citation title: Type type: string container_id: title: Container Id type: string end_index: title: End Index type: integer file_id: title: File Id type: string filename: title: Filename type: string start_index: title: Start Index type: integer required: - container_id - end_index - file_id - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation type: object OpenAIResponseAnnotationFileCitation: description: File citation annotation for referencing specific files in response content. properties: type: const: file_citation default: file_citation title: Type type: string file_id: title: File Id type: string filename: title: Filename type: string index: title: Index type: integer required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation type: object OpenAIResponseAnnotationFilePath: properties: type: const: file_path default: file_path title: Type type: string file_id: title: File Id type: string index: title: Index type: integer required: - file_id - index title: OpenAIResponseAnnotationFilePath type: object OpenAIResponseAnnotations: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: description: Refusal content within a streamed response part. properties: type: const: refusal default: refusal title: Type type: string refusal: title: Refusal type: string required: - refusal title: OpenAIResponseContentPartRefusal type: object OpenAIResponseOutputMessageContentOutputText: properties: text: title: Text type: string type: const: output_text default: output_text title: Type type: string annotations: items: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: Annotations type: array required: - text title: OpenAIResponseOutputMessageContentOutputText type: object OpenAIResponseOutputMessageContent: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' title: OpenAIResponseOutputMessageContentOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal MCPListToolsTool: description: Tool definition returned by MCP list tools operation. properties: input_schema: additionalProperties: true title: Input Schema type: object name: title: Name type: string description: anyOf: - type: string - type: 'null' nullable: true required: - input_schema - name title: MCPListToolsTool type: object OpenAIResponseMCPApprovalRequest: description: A request for human approval of a tool invocation. properties: arguments: title: Arguments type: string id: title: Id type: string name: title: Name type: string server_label: title: Server Label type: string type: const: mcp_approval_request default: mcp_approval_request title: Type type: string required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest type: object OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same "type" value, and there is no way to tell them apart in certain scenarios. properties: content: anyOf: - type: string - items: discriminator: mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: array title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - items: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' title: OpenAIResponseOutputMessageContentOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal type: array title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] role: title: Role type: string enum: - system - developer - user - assistant default: system type: const: message default: message title: Type type: string id: anyOf: - type: string - type: 'null' nullable: true status: anyOf: - type: string - type: 'null' nullable: true required: - content - role title: OpenAIResponseMessage type: object OpenAIResponseOutputMessageFileSearchToolCall: description: File search tool call output message for OpenAI responses. properties: id: title: Id type: string queries: items: type: string title: Queries type: array status: title: Status type: string type: const: file_search_call default: file_search_call title: Type type: string results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' nullable: true required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall type: object OpenAIResponseOutputMessageFileSearchToolCallResults: description: Search results returned by the file search operation. properties: attributes: additionalProperties: true title: Attributes type: object file_id: title: File Id type: string filename: title: Filename type: string score: title: Score type: number text: title: Text type: string required: - attributes - file_id - filename - score - text title: OpenAIResponseOutputMessageFileSearchToolCallResults type: object OpenAIResponseOutputMessageFunctionToolCall: description: Function tool call output message for OpenAI responses. properties: call_id: title: Call Id type: string name: title: Name type: string arguments: title: Arguments type: string type: const: function_call default: function_call title: Type type: string id: anyOf: - type: string - type: 'null' nullable: true status: anyOf: - type: string - type: 'null' nullable: true required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall type: object OpenAIResponseOutputMessageMCPCall: description: Model Context Protocol (MCP) call output message for OpenAI responses. properties: id: title: Id type: string type: const: mcp_call default: mcp_call title: Type type: string arguments: title: Arguments type: string name: title: Name type: string server_label: title: Server Label type: string error: anyOf: - type: string - type: 'null' nullable: true output: anyOf: - type: string - type: 'null' nullable: true required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall type: object OpenAIResponseOutputMessageMCPListTools: description: MCP list tools output message containing available tools from an MCP server. properties: id: title: Id type: string type: const: mcp_list_tools default: mcp_list_tools title: Type type: string server_label: title: Server Label type: string tools: items: $ref: '#/components/schemas/MCPListToolsTool' title: Tools type: array required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools type: object OpenAIResponseOutputMessageWebSearchToolCall: description: Web search tool call output message for OpenAI responses. properties: id: title: Id type: string status: title: Status type: string type: const: web_search_call default: web_search_call title: Type type: string required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall type: object OpenAIResponseOutput: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) AllowedToolsFilter: description: Filter configuration for restricting which MCP tools can be used. properties: tool_names: anyOf: - items: type: string type: array - type: 'null' nullable: true title: AllowedToolsFilter type: object ApprovalFilter: description: Filter configuration for MCP tool approval requirements. properties: always: anyOf: - items: type: string type: array - type: 'null' nullable: true never: anyOf: - items: type: string type: array - type: 'null' nullable: true title: ApprovalFilter type: object OpenAIResponseInputToolFileSearch: description: File search tool configuration for OpenAI response inputs. properties: type: const: file_search default: file_search title: Type type: string vector_store_ids: items: type: string title: Vector Store Ids type: array filters: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true max_num_results: anyOf: - maximum: 50 minimum: 1 type: integer - type: 'null' default: 10 ranking_options: anyOf: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' nullable: true title: SearchRankingOptions required: - vector_store_ids title: OpenAIResponseInputToolFileSearch type: object OpenAIResponseInputToolFunction: description: Function tool configuration for OpenAI response inputs. properties: type: const: function default: function title: Type type: string name: title: Name type: string description: anyOf: - type: string - type: 'null' nullable: true parameters: anyOf: - additionalProperties: true type: object - type: 'null' strict: anyOf: - type: boolean - type: 'null' nullable: true required: - name - parameters title: OpenAIResponseInputToolFunction type: object OpenAIResponseInputToolMCP: description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. properties: type: const: mcp default: mcp title: Type type: string server_label: title: Server Label type: string server_url: title: Server Url type: string headers: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true authorization: anyOf: - type: string - type: 'null' nullable: true require_approval: anyOf: - const: always type: string - const: never type: string - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter default: never title: string | ApprovalFilter allowed_tools: anyOf: - items: type: string type: array title: list[string] - $ref: '#/components/schemas/AllowedToolsFilter' title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter nullable: true required: - server_label - server_url title: OpenAIResponseInputToolMCP type: object OpenAIResponseInputToolWebSearch: description: Web search tool configuration for OpenAI response inputs. properties: type: default: web_search title: Type type: string enum: - web_search - web_search_preview - web_search_preview_2025_03_11 - web_search_2025_08_26 search_context_size: anyOf: - pattern: ^low|medium|high$ type: string - type: 'null' default: medium title: OpenAIResponseInputToolWebSearch type: object SearchRankingOptions: description: Options for ranking and filtering search results. properties: ranker: anyOf: - type: string - type: 'null' nullable: true score_threshold: anyOf: - type: number - type: 'null' default: 0.0 title: SearchRankingOptions type: object OpenAIResponseInputTool: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: description: Model Context Protocol (MCP) tool configuration for OpenAI response object. properties: type: const: mcp default: mcp title: Type type: string server_label: title: Server Label type: string allowed_tools: anyOf: - items: type: string type: array title: list[string] - $ref: '#/components/schemas/AllowedToolsFilter' title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter nullable: true required: - server_label title: OpenAIResponseToolMCP type: object OpenAIResponseTool: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: type: const: output_text default: output_text title: Type type: string text: title: Text type: string annotations: items: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: Annotations type: array logprobs: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' nullable: true required: - text title: OpenAIResponseContentPartOutputText type: object OpenAIResponseContentPartReasoningText: description: Reasoning text emitted as part of a streamed response. properties: type: const: reasoning_text default: reasoning_text title: Type type: string text: title: Text type: string required: - text title: OpenAIResponseContentPartReasoningText type: object OpenAIResponseContentPart: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' title: OpenAIResponseContentPartOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText OpenAIResponseContentPartReasoningSummary: description: Reasoning summary part in a streamed response. properties: type: const: summary_text default: summary_text title: Type type: string text: title: Text type: string required: - text title: OpenAIResponseContentPartReasoningSummary type: object OpenAIResponseError: description: Error details for failed OpenAI response requests. properties: code: title: Code type: string message: title: Message type: string required: - code - message title: OpenAIResponseError type: object OpenAIResponseObject: description: Complete OpenAI response object containing generation results and metadata. properties: created_at: title: Created At type: integer error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' nullable: true title: OpenAIResponseError id: title: Id type: string model: title: Model type: string object: const: response default: response title: Object type: string output: items: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) title: Output type: array parallel_tool_calls: default: false title: Parallel Tool Calls type: boolean previous_response_id: anyOf: - type: string - type: 'null' nullable: true prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' nullable: true title: OpenAIResponsePrompt status: title: Status type: string temperature: anyOf: - type: number - type: 'null' nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: format: type: text top_p: anyOf: - type: number - type: 'null' nullable: true tools: anyOf: - items: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) type: array - type: 'null' nullable: true truncation: anyOf: - type: string - type: 'null' nullable: true usage: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsage' title: OpenAIResponseUsage - type: 'null' nullable: true title: OpenAIResponseUsage instructions: anyOf: - type: string - type: 'null' nullable: true max_tool_calls: anyOf: - type: integer - type: 'null' nullable: true required: - created_at - id - model - output - status title: OpenAIResponseObject type: object OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' type: const: response.completed default: response.completed title: Type type: string required: - response title: OpenAIResponseObjectStreamResponseCompleted type: object OpenAIResponseObjectStreamResponseContentPartAdded: description: Streaming event for when a new content part is added to a response item. properties: content_index: title: Content Index type: integer response_id: title: Response Id type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer part: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' title: OpenAIResponseContentPartOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText sequence_number: title: Sequence Number type: integer type: const: response.content_part.added default: response.content_part.added title: Type type: string required: - content_index - response_id - item_id - output_index - part - sequence_number title: OpenAIResponseObjectStreamResponseContentPartAdded type: object OpenAIResponseObjectStreamResponseContentPartDone: description: Streaming event for when a content part is completed. properties: content_index: title: Content Index type: integer response_id: title: Response Id type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer part: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' title: OpenAIResponseContentPartOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText sequence_number: title: Sequence Number type: integer type: const: response.content_part.done default: response.content_part.done title: Type type: string required: - content_index - response_id - item_id - output_index - part - sequence_number title: OpenAIResponseObjectStreamResponseContentPartDone type: object OpenAIResponseObjectStreamResponseCreated: description: Streaming event indicating a new response has been created. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' type: const: response.created default: response.created title: Type type: string required: - response title: OpenAIResponseObjectStreamResponseCreated type: object OpenAIResponseObjectStreamResponseFailed: description: Streaming event emitted when a response fails. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: const: response.failed default: response.failed title: Type type: string required: - response - sequence_number title: OpenAIResponseObjectStreamResponseFailed type: object OpenAIResponseObjectStreamResponseFileSearchCallCompleted: description: Streaming event for completed file search calls. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.file_search_call.completed default: response.file_search_call.completed title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted type: object OpenAIResponseObjectStreamResponseFileSearchCallInProgress: description: Streaming event for file search calls in progress. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.file_search_call.in_progress default: response.file_search_call.in_progress title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress type: object OpenAIResponseObjectStreamResponseFileSearchCallSearching: description: Streaming event for file search currently searching. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.file_search_call.searching default: response.file_search_call.searching title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFileSearchCallSearching type: object OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta: description: Streaming event for incremental function call argument updates. properties: delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.function_call_arguments.delta default: response.function_call_arguments.delta title: Type type: string required: - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta type: object OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone: description: Streaming event for when function call arguments are completed. properties: arguments: title: Arguments type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.function_call_arguments.done default: response.function_call_arguments.done title: Type type: string required: - arguments - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone type: object OpenAIResponseObjectStreamResponseInProgress: description: Streaming event indicating the response remains in progress. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: const: response.in_progress default: response.in_progress title: Type type: string required: - response - sequence_number title: OpenAIResponseObjectStreamResponseInProgress type: object OpenAIResponseObjectStreamResponseIncomplete: description: Streaming event emitted when a response ends in an incomplete state. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: const: response.incomplete default: response.incomplete title: Type type: string required: - response - sequence_number title: OpenAIResponseObjectStreamResponseIncomplete type: object OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta: properties: delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.arguments.delta default: response.mcp_call.arguments.delta title: Type type: string required: - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta type: object OpenAIResponseObjectStreamResponseMcpCallArgumentsDone: properties: arguments: title: Arguments type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.arguments.done default: response.mcp_call.arguments.done title: Type type: string required: - arguments - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone type: object OpenAIResponseObjectStreamResponseMcpCallCompleted: description: Streaming event for completed MCP calls. properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.completed default: response.mcp_call.completed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallCompleted type: object OpenAIResponseObjectStreamResponseMcpCallFailed: description: Streaming event for failed MCP calls. properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.failed default: response.mcp_call.failed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallFailed type: object OpenAIResponseObjectStreamResponseMcpCallInProgress: description: Streaming event for MCP calls in progress. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.in_progress default: response.mcp_call.in_progress title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallInProgress type: object OpenAIResponseObjectStreamResponseMcpListToolsCompleted: properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_list_tools.completed default: response.mcp_list_tools.completed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted type: object OpenAIResponseObjectStreamResponseMcpListToolsFailed: properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_list_tools.failed default: response.mcp_list_tools.failed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsFailed type: object OpenAIResponseObjectStreamResponseMcpListToolsInProgress: properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_list_tools.in_progress default: response.mcp_list_tools.in_progress title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress type: object OpenAIResponseObjectStreamResponseOutputItemAdded: description: Streaming event for when a new output item is added to the response. properties: response_id: title: Response Id type: string item: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_item.added default: response.output_item.added title: Type type: string required: - response_id - item - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputItemAdded type: object OpenAIResponseObjectStreamResponseOutputItemDone: description: Streaming event for when an output item is completed. properties: response_id: title: Response Id type: string item: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_item.done default: response.output_item.done title: Type type: string required: - response_id - item - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputItemDone type: object OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded: description: Streaming event for when an annotation is added to output text. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer content_index: title: Content Index type: integer annotation_index: title: Annotation Index type: integer annotation: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) sequence_number: title: Sequence Number type: integer type: const: response.output_text.annotation.added default: response.output_text.annotation.added title: Type type: string required: - item_id - output_index - content_index - annotation_index - annotation - sequence_number title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded type: object OpenAIResponseObjectStreamResponseOutputTextDelta: description: Streaming event for incremental text content updates. properties: content_index: title: Content Index type: integer delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_text.delta default: response.output_text.delta title: Type type: string required: - content_index - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputTextDelta type: object OpenAIResponseObjectStreamResponseOutputTextDone: description: Streaming event for when text output is completed. properties: content_index: title: Content Index type: integer text: title: Text type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_text.done default: response.output_text.done title: Type type: string required: - content_index - text - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputTextDone type: object OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded: description: Streaming event for when a new reasoning summary part is added. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer part: $ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary' sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_part.added default: response.reasoning_summary_part.added title: Type type: string required: - item_id - output_index - part - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded type: object OpenAIResponseObjectStreamResponseReasoningSummaryPartDone: description: Streaming event for when a reasoning summary part is completed. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer part: $ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary' sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_part.done default: response.reasoning_summary_part.done title: Type type: string required: - item_id - output_index - part - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone type: object OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta: description: Streaming event for incremental reasoning summary text updates. properties: delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_text.delta default: response.reasoning_summary_text.delta title: Type type: string required: - delta - item_id - output_index - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta type: object OpenAIResponseObjectStreamResponseReasoningSummaryTextDone: description: Streaming event for when reasoning summary text is completed. properties: text: title: Text type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_text.done default: response.reasoning_summary_text.done title: Type type: string required: - text - item_id - output_index - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone type: object OpenAIResponseObjectStreamResponseReasoningTextDelta: description: Streaming event for incremental reasoning text updates. properties: content_index: title: Content Index type: integer delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.reasoning_text.delta default: response.reasoning_text.delta title: Type type: string required: - content_index - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseReasoningTextDelta type: object OpenAIResponseObjectStreamResponseReasoningTextDone: description: Streaming event for when reasoning text is completed. properties: content_index: title: Content Index type: integer text: title: Text type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.reasoning_text.done default: response.reasoning_text.done title: Type type: string required: - content_index - text - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseReasoningTextDone type: object OpenAIResponseObjectStreamResponseRefusalDelta: description: Streaming event for incremental refusal text updates. properties: content_index: title: Content Index type: integer delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.refusal.delta default: response.refusal.delta title: Type type: string required: - content_index - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseRefusalDelta type: object OpenAIResponseObjectStreamResponseRefusalDone: description: Streaming event for when refusal text is completed. properties: content_index: title: Content Index type: integer refusal: title: Refusal type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.refusal.done default: response.refusal.done title: Type type: string required: - content_index - refusal - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseRefusalDone type: object OpenAIResponseObjectStreamResponseWebSearchCallCompleted: description: Streaming event for completed web search calls. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.web_search_call.completed default: response.web_search_call.completed title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted type: object OpenAIResponseObjectStreamResponseWebSearchCallInProgress: description: Streaming event for web search calls in progress. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.web_search_call.in_progress default: response.web_search_call.in_progress title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress type: object OpenAIResponseObjectStreamResponseWebSearchCallSearching: properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.web_search_call.searching default: response.web_search_call.searching title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIResponsePrompt: description: OpenAI compatible Prompt object that is used in OpenAI responses. properties: id: title: Id type: string variables: anyOf: - additionalProperties: discriminator: mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' nullable: true version: anyOf: - type: string - type: 'null' nullable: true required: - id title: OpenAIResponsePrompt type: object OpenAIResponseText: description: Text response configuration for OpenAI responses. properties: format: anyOf: - $ref: '#/components/schemas/OpenAIResponseTextFormat' title: OpenAIResponseTextFormat - type: 'null' nullable: true title: OpenAIResponseTextFormat title: OpenAIResponseText type: object OpenAIResponseTextFormat: description: Configuration for Responses API text format. properties: type: title: Type type: string enum: - text - json_schema - json_object default: text name: anyOf: - type: string - type: 'null' schema: anyOf: - additionalProperties: true type: object - type: 'null' description: anyOf: - type: string - type: 'null' strict: anyOf: - type: boolean - type: 'null' title: OpenAIResponseTextFormat type: object OpenAIResponseUsage: description: Usage information for OpenAI response. properties: input_tokens: title: Input Tokens type: integer output_tokens: title: Output Tokens type: integer total_tokens: title: Total Tokens type: integer input_tokens_details: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' title: OpenAIResponseUsageInputTokensDetails - type: 'null' nullable: true title: OpenAIResponseUsageInputTokensDetails output_tokens_details: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' title: OpenAIResponseUsageOutputTokensDetails - type: 'null' nullable: true title: OpenAIResponseUsageOutputTokensDetails required: - input_tokens - output_tokens - total_tokens title: OpenAIResponseUsage type: object OpenAIResponseUsageInputTokensDetails: description: Token details for input tokens in OpenAI response usage. properties: cached_tokens: anyOf: - type: integer - type: 'null' nullable: true title: OpenAIResponseUsageInputTokensDetails type: object OpenAIResponseUsageOutputTokensDetails: description: Token details for output tokens in OpenAI response usage. properties: reasoning_tokens: anyOf: - type: integer - type: 'null' nullable: true title: OpenAIResponseUsageOutputTokensDetails type: object OpenAIResponseObjectStream: discriminator: mapping: response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' response.file_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' response.file_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' response.file_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' response.function_call_arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' response.function_call_arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' response.mcp_call.arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' response.mcp_call.arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' response.mcp_call.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' response.mcp_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' response.mcp_list_tools.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' response.mcp_list_tools.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' response.mcp_list_tools.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' response.output_text.annotation.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' response.output_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' response.reasoning_summary_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' response.reasoning_summary_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' response.reasoning_summary_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' response.reasoning_summary_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' response.reasoning_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' response.reasoning_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' response.refusal.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' response.refusal.done: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' response.web_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' response.web_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' response.web_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' title: OpenAIResponseObjectStreamResponseCreated - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' title: OpenAIResponseObjectStreamResponseInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' title: OpenAIResponseObjectStreamResponseOutputItemAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' title: OpenAIResponseObjectStreamResponseOutputItemDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' title: OpenAIResponseObjectStreamResponseOutputTextDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' title: OpenAIResponseObjectStreamResponseOutputTextDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' title: OpenAIResponseObjectStreamResponseWebSearchCallSearching - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' title: OpenAIResponseObjectStreamResponseMcpListToolsFailed - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' title: OpenAIResponseObjectStreamResponseMcpCallInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' title: OpenAIResponseObjectStreamResponseMcpCallFailed - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' title: OpenAIResponseObjectStreamResponseMcpCallCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' title: OpenAIResponseObjectStreamResponseContentPartAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' title: OpenAIResponseObjectStreamResponseContentPartDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' title: OpenAIResponseObjectStreamResponseReasoningTextDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' title: OpenAIResponseObjectStreamResponseReasoningTextDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' title: OpenAIResponseObjectStreamResponseRefusalDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' title: OpenAIResponseObjectStreamResponseRefusalDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' title: OpenAIResponseObjectStreamResponseFileSearchCallSearching - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' title: OpenAIResponseObjectStreamResponseIncomplete - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' title: OpenAIResponseObjectStreamResponseFailed - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) OpenAIResponseInputFunctionToolCallOutput: description: This represents the output of a function call that gets passed back to the model. properties: call_id: title: Call Id type: string output: title: Output type: string type: const: function_call_output default: function_call_output title: Type type: string id: anyOf: - type: string - type: 'null' nullable: true status: anyOf: - type: string - type: 'null' nullable: true required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput type: object OpenAIResponseMCPApprovalResponse: description: A response to an MCP approval request. properties: approval_request_id: title: Approval Request Id type: string approve: title: Approve type: boolean type: const: mcp_approval_response default: mcp_approval_response title: Type type: string id: anyOf: - type: string - type: 'null' nullable: true reason: anyOf: - type: string - type: 'null' nullable: true required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse type: object OpenAIResponseInput: anyOf: - discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage ArrayType: description: Parameter type for array values. properties: type: const: array default: array title: Type type: string title: ArrayType type: object BooleanType: description: Parameter type for boolean values. properties: type: const: boolean default: boolean title: Type type: string title: BooleanType type: object ChatCompletionInputType: description: Parameter type for chat completion input. properties: type: const: chat_completion_input default: chat_completion_input title: Type type: string title: ChatCompletionInputType type: object CompletionInputType: description: Parameter type for completion input. properties: type: const: completion_input default: completion_input title: Type type: string title: CompletionInputType type: object JsonType: description: Parameter type for JSON values. properties: type: const: json default: json title: Type type: string title: JsonType type: object NumberType: description: Parameter type for numeric values. properties: type: const: number default: number title: Type type: string title: NumberType type: object ObjectType: description: Parameter type for object values. properties: type: const: object default: object title: Type type: string title: ObjectType type: object StringType: description: Parameter type for string values. properties: type: const: string default: string title: Type type: string title: StringType type: object UnionType: description: Parameter type for union values. properties: type: const: union default: union title: Type type: string title: UnionType type: object ParamType: discriminator: mapping: array: '#/components/schemas/ArrayType' boolean: '#/components/schemas/BooleanType' chat_completion_input: '#/components/schemas/ChatCompletionInputType' completion_input: '#/components/schemas/CompletionInputType' json: '#/components/schemas/JsonType' number: '#/components/schemas/NumberType' object: '#/components/schemas/ObjectType' string: '#/components/schemas/StringType' union: '#/components/schemas/UnionType' propertyName: type oneOf: - $ref: '#/components/schemas/StringType' title: StringType - $ref: '#/components/schemas/NumberType' title: NumberType - $ref: '#/components/schemas/BooleanType' title: BooleanType - $ref: '#/components/schemas/ArrayType' title: ArrayType - $ref: '#/components/schemas/ObjectType' title: ObjectType - $ref: '#/components/schemas/JsonType' title: JsonType - $ref: '#/components/schemas/UnionType' title: UnionType - $ref: '#/components/schemas/ChatCompletionInputType' title: ChatCompletionInputType - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) ConversationItem: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) RowsDataSource: description: A dataset stored in rows. properties: type: const: rows default: rows title: Type type: string rows: items: additionalProperties: true type: object title: Rows type: array required: - rows title: RowsDataSource type: object URIDataSource: description: A dataset that can be obtained from a URI. properties: type: const: uri default: uri title: Type type: string uri: title: Uri type: string required: - uri title: URIDataSource type: object DataSource: discriminator: mapping: rows: '#/components/schemas/RowsDataSource' uri: '#/components/schemas/URIDataSource' propertyName: type oneOf: - $ref: '#/components/schemas/URIDataSource' title: URIDataSource - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource AggregationFunctionType: description: Types of aggregation functions for scoring results. enum: - average - weighted_average - median - categorical_count - accuracy title: AggregationFunctionType type: string BasicScoringFnParams: description: Parameters for basic scoring function configuration. properties: type: const: basic default: basic title: Type type: string aggregation_functions: description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' title: Aggregation Functions type: array title: BasicScoringFnParams type: object LLMAsJudgeScoringFnParams: description: Parameters for LLM-as-judge scoring function configuration. properties: type: const: llm_as_judge default: llm_as_judge title: Type type: string judge_model: title: Judge Model type: string prompt_template: anyOf: - type: string - type: 'null' nullable: true judge_score_regexes: description: Regexes to extract the answer from generated response items: type: string title: Judge Score Regexes type: array aggregation_functions: description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' title: Aggregation Functions type: array required: - judge_model title: LLMAsJudgeScoringFnParams type: object RegexParserScoringFnParams: description: Parameters for regex parser scoring function configuration. properties: type: const: regex_parser default: regex_parser title: Type type: string parsing_regexes: description: Regex to extract the answer from generated response items: type: string title: Parsing Regexes type: array aggregation_functions: description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' title: Aggregation Functions type: array title: RegexParserScoringFnParams type: object ScoringFnParams: discriminator: mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' propertyName: type oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams LoraFinetuningConfig: description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. properties: type: const: LoRA default: LoRA title: Type type: string lora_attn_modules: items: type: string title: Lora Attn Modules type: array apply_lora_to_mlp: title: Apply Lora To Mlp type: boolean apply_lora_to_output: title: Apply Lora To Output type: boolean rank: title: Rank type: integer alpha: title: Alpha type: integer use_dora: anyOf: - type: boolean - type: 'null' default: false quantize_base: anyOf: - type: boolean - type: 'null' default: false required: - lora_attn_modules - apply_lora_to_mlp - apply_lora_to_output - rank - alpha title: LoraFinetuningConfig type: object QATFinetuningConfig: description: Configuration for Quantization-Aware Training (QAT) fine-tuning. properties: type: const: QAT default: QAT title: Type type: string quantizer_name: title: Quantizer Name type: string group_size: title: Group Size type: integer required: - quantizer_name - group_size title: QATFinetuningConfig type: object AlgorithmConfig: discriminator: mapping: LoRA: '#/components/schemas/LoraFinetuningConfig' QAT: '#/components/schemas/QATFinetuningConfig' propertyName: type oneOf: - $ref: '#/components/schemas/LoraFinetuningConfig' title: LoraFinetuningConfig - $ref: '#/components/schemas/QATFinetuningConfig' title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig SpanEndPayload: description: Payload for a span end event. properties: type: const: span_end default: span_end title: Type type: string status: $ref: '#/components/schemas/SpanStatus' required: - status title: SpanEndPayload type: object SpanStartPayload: description: Payload for a span start event. properties: type: const: span_start default: span_start title: Type type: string name: title: Name type: string parent_span_id: anyOf: - type: string - type: 'null' nullable: true required: - name title: SpanStartPayload type: object SpanStatus: description: The status of a span indicating whether it completed successfully or with an error. enum: - ok - error title: SpanStatus type: string StructuredLogPayload: discriminator: mapping: span_end: '#/components/schemas/SpanEndPayload' span_start: '#/components/schemas/SpanStartPayload' propertyName: type oneOf: - $ref: '#/components/schemas/SpanStartPayload' title: SpanStartPayload - $ref: '#/components/schemas/SpanEndPayload' title: SpanEndPayload title: SpanStartPayload | SpanEndPayload LogSeverity: description: The severity level of a log message. enum: - verbose - debug - info - warn - error - critical title: LogSeverity type: string MetricEvent: description: A metric event containing a measured value. properties: trace_id: title: Trace Id type: string span_id: title: Span Id type: string timestamp: format: date-time title: Timestamp type: string attributes: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean - type: 'null' title: string | ... (4 variants) type: object - type: 'null' type: const: metric default: metric title: Type type: string metric: title: Metric type: string value: anyOf: - type: integer - type: number title: integer | number unit: title: Unit type: string required: - trace_id - span_id - timestamp - metric - value - unit title: MetricEvent type: object StructuredLogEvent: description: A structured log event containing typed payload data. properties: trace_id: title: Trace Id type: string span_id: title: Span Id type: string timestamp: format: date-time title: Timestamp type: string attributes: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean - type: 'null' title: string | ... (4 variants) type: object - type: 'null' type: const: structured_log default: structured_log title: Type type: string payload: discriminator: mapping: span_end: '#/components/schemas/SpanEndPayload' span_start: '#/components/schemas/SpanStartPayload' propertyName: type oneOf: - $ref: '#/components/schemas/SpanStartPayload' title: SpanStartPayload - $ref: '#/components/schemas/SpanEndPayload' title: SpanEndPayload title: SpanStartPayload | SpanEndPayload required: - trace_id - span_id - timestamp - payload title: StructuredLogEvent type: object UnstructuredLogEvent: description: An unstructured log event containing a simple text message. properties: trace_id: title: Trace Id type: string span_id: title: Span Id type: string timestamp: format: date-time title: Timestamp type: string attributes: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean - type: 'null' title: string | ... (4 variants) type: object - type: 'null' type: const: unstructured_log default: unstructured_log title: Type type: string message: title: Message type: string severity: $ref: '#/components/schemas/LogSeverity' required: - trace_id - span_id - timestamp - message - severity title: UnstructuredLogEvent type: object Event: discriminator: mapping: metric: '#/components/schemas/MetricEvent' structured_log: '#/components/schemas/StructuredLogEvent' unstructured_log: '#/components/schemas/UnstructuredLogEvent' propertyName: type oneOf: - $ref: '#/components/schemas/UnstructuredLogEvent' title: UnstructuredLogEvent - $ref: '#/components/schemas/MetricEvent' title: MetricEvent - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent ListOpenAIResponseInputItem: description: List container for OpenAI response input items. properties: data: items: anyOf: - discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage title: Data type: array object: const: list default: list title: Object type: string required: - data title: ListOpenAIResponseInputItem type: object OpenAIResponseObjectWithInput: description: OpenAI response object extended with input context information. properties: created_at: title: Created At type: integer error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' nullable: true title: OpenAIResponseError id: title: Id type: string model: title: Model type: string object: const: response default: response title: Object type: string output: items: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) title: Output type: array parallel_tool_calls: default: false title: Parallel Tool Calls type: boolean previous_response_id: anyOf: - type: string - type: 'null' nullable: true prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' nullable: true title: OpenAIResponsePrompt status: title: Status type: string temperature: anyOf: - type: number - type: 'null' nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: format: type: text top_p: anyOf: - type: number - type: 'null' nullable: true tools: anyOf: - items: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) type: array - type: 'null' nullable: true truncation: anyOf: - type: string - type: 'null' nullable: true usage: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsage' title: OpenAIResponseUsage - type: 'null' nullable: true title: OpenAIResponseUsage instructions: anyOf: - type: string - type: 'null' nullable: true max_tool_calls: anyOf: - type: integer - type: 'null' nullable: true input: items: anyOf: - discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage title: Input type: array required: - created_at - id - model - output - status - input title: OpenAIResponseObjectWithInput type: object ListOpenAIResponseObject: description: Paginated list of OpenAI response objects with navigation metadata. properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' title: Data type: array has_more: title: Has More type: boolean first_id: title: First Id type: string last_id: title: Last Id type: string object: const: list default: list title: Object type: string required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject type: object OpenAIDeleteResponseObject: description: Response object confirming deletion of an OpenAI response. properties: id: title: Id type: string object: const: response default: response title: Object type: string deleted: default: true title: Deleted type: boolean required: - id title: OpenAIDeleteResponseObject type: object ResponseGuardrailSpec: description: Specification for a guardrail to apply during response generation. properties: type: title: Type type: string required: - type title: ResponseGuardrailSpec type: object Batch: additionalProperties: true properties: id: title: Id type: string completion_window: title: Completion Window type: string created_at: title: Created At type: integer endpoint: title: Endpoint type: string input_file_id: title: Input File Id type: string object: const: batch title: Object type: string status: enum: - validating - failed - in_progress - finalizing - completed - expired - cancelling - cancelled title: Status type: string cancelled_at: anyOf: - type: integer - type: 'null' nullable: true cancelling_at: anyOf: - type: integer - type: 'null' nullable: true completed_at: anyOf: - type: integer - type: 'null' nullable: true error_file_id: anyOf: - type: string - type: 'null' nullable: true errors: anyOf: - $ref: '#/components/schemas/Errors' title: Errors - type: 'null' nullable: true title: Errors expired_at: anyOf: - type: integer - type: 'null' nullable: true expires_at: anyOf: - type: integer - type: 'null' nullable: true failed_at: anyOf: - type: integer - type: 'null' nullable: true finalizing_at: anyOf: - type: integer - type: 'null' nullable: true in_progress_at: anyOf: - type: integer - type: 'null' nullable: true metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' nullable: true model: anyOf: - type: string - type: 'null' nullable: true output_file_id: anyOf: - type: string - type: 'null' nullable: true request_counts: anyOf: - $ref: '#/components/schemas/BatchRequestCounts' title: BatchRequestCounts - type: 'null' nullable: true title: BatchRequestCounts usage: anyOf: - $ref: '#/components/schemas/BatchUsage' title: BatchUsage - type: 'null' nullable: true title: BatchUsage required: - id - completion_window - created_at - endpoint - input_file_id - object - status title: Batch type: object BatchError: additionalProperties: true properties: code: anyOf: - type: string - type: 'null' nullable: true line: anyOf: - type: integer - type: 'null' nullable: true message: anyOf: - type: string - type: 'null' nullable: true param: anyOf: - type: string - type: 'null' nullable: true title: BatchError type: object BatchRequestCounts: additionalProperties: true properties: completed: title: Completed type: integer failed: title: Failed type: integer total: title: Total type: integer required: - completed - failed - total title: BatchRequestCounts type: object BatchUsage: additionalProperties: true properties: input_tokens: title: Input Tokens type: integer input_tokens_details: $ref: '#/components/schemas/InputTokensDetails' output_tokens: title: Output Tokens type: integer output_tokens_details: $ref: '#/components/schemas/OutputTokensDetails' total_tokens: title: Total Tokens type: integer required: - input_tokens - input_tokens_details - output_tokens - output_tokens_details - total_tokens title: BatchUsage type: object Errors: additionalProperties: true properties: data: anyOf: - items: $ref: '#/components/schemas/BatchError' type: array - type: 'null' nullable: true object: anyOf: - type: string - type: 'null' nullable: true title: Errors type: object InputTokensDetails: additionalProperties: true properties: cached_tokens: title: Cached Tokens type: integer required: - cached_tokens title: InputTokensDetails type: object OutputTokensDetails: additionalProperties: true properties: reasoning_tokens: title: Reasoning Tokens type: integer required: - reasoning_tokens title: OutputTokensDetails type: object ListBatchesResponse: description: Response containing a list of batch objects. properties: object: const: list default: list title: Object type: string data: description: List of batch objects items: $ref: '#/components/schemas/Batch' title: Data type: array first_id: anyOf: - type: string - type: 'null' description: ID of the first batch in the list nullable: true last_id: anyOf: - type: string - type: 'null' description: ID of the last batch in the list nullable: true has_more: default: false description: Whether there are more batches available title: Has More type: boolean required: - data title: ListBatchesResponse type: object Benchmark: description: A benchmark resource for evaluating model performance. properties: identifier: description: Unique identifier for this resource in llama stack title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: const: benchmark default: benchmark title: Type type: string dataset_id: title: Dataset Id type: string scoring_functions: items: type: string title: Scoring Functions type: array metadata: additionalProperties: true description: Metadata for this evaluation task title: Metadata type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark type: object ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' title: Data type: array required: - data title: ListBenchmarksResponse type: object ImageDelta: description: An image content delta for streaming responses. properties: type: const: image default: image title: Type type: string image: format: binary title: Image type: string required: - image title: ImageDelta type: object TextDelta: description: A text content delta for streaming responses. properties: type: const: text default: text title: Type type: string text: title: Text type: string required: - text title: TextDelta type: object JobStatus: description: Status of a job execution. enum: - completed - in_progress - failed - scheduled - cancelled title: JobStatus type: string Job: description: A job execution instance with status tracking. properties: job_id: title: Job Id type: string status: $ref: '#/components/schemas/JobStatus' required: - job_id - status title: Job type: object MetricInResponse: description: A metric value included in API responses. properties: metric: title: Metric type: string value: anyOf: - type: integer - type: number title: integer | number unit: anyOf: - type: string - type: 'null' nullable: true required: - metric - value title: MetricInResponse type: object PaginatedResponse: description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object title: Data type: array has_more: title: Has More type: boolean url: anyOf: - type: string - type: 'null' nullable: true required: - data - has_more title: PaginatedResponse type: object PostTrainingMetric: description: Training metrics captured during post-training jobs. properties: epoch: title: Epoch type: integer train_loss: title: Train Loss type: number validation_loss: title: Validation Loss type: number perplexity: title: Perplexity type: number required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric type: object Checkpoint: description: Checkpoint created during training runs. properties: identifier: title: Identifier type: string created_at: format: date-time title: Created At type: string epoch: title: Epoch type: integer post_training_job_id: title: Post Training Job Id type: string path: title: Path type: string training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' nullable: true title: PostTrainingMetric required: - identifier - created_at - epoch - post_training_job_id - path title: Checkpoint type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: type: const: dialog default: dialog title: Type type: string title: DialogType type: object Conversation: description: OpenAI-compatible conversation object. properties: id: description: The unique ID of the conversation. title: Id type: string object: const: conversation default: conversation description: The object type, which is always conversation. title: Object type: string created_at: description: The time at which the conversation was created, measured in seconds since the Unix epoch. title: Created At type: integer metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. nullable: true items: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' description: Initial items to include in the conversation context. You may add up to 20 items at a time. nullable: true required: - id - created_at title: Conversation type: object ConversationDeletedResource: description: Response for deleted conversation. properties: id: description: The deleted conversation identifier title: Id type: string object: default: conversation.deleted description: Object type title: Object type: string deleted: default: true description: Whether the object was deleted title: Deleted type: boolean required: - id title: ConversationDeletedResource type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: items: description: Items to include in the conversation context. You may add up to 20 items at a time. items: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) maxItems: 20 title: Items type: array required: - items title: ConversationItemCreateRequest type: object ConversationItemDeletedResource: description: Response for deleted conversation item. properties: id: description: The deleted item identifier title: Id type: string object: default: conversation.item.deleted description: Object type title: Object type: string deleted: default: true description: Whether the object was deleted title: Deleted type: boolean required: - id title: ConversationItemDeletedResource type: object ConversationItemList: description: List of conversation items with pagination. properties: object: default: list description: Object type title: Object type: string data: description: List of conversation items items: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) title: Data type: array first_id: anyOf: - type: string - type: 'null' description: The ID of the first item in the list nullable: true last_id: anyOf: - type: string - type: 'null' description: The ID of the last item in the list nullable: true has_more: default: false description: Whether there are more items available title: Has More type: boolean required: - data title: ConversationItemList type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: id: description: unique identifier for this message title: Id type: string content: description: message content items: additionalProperties: true type: object title: Content type: array role: description: message role title: Role type: string status: description: message status title: Status type: string type: const: message default: message title: Type type: string object: const: message default: message title: Object type: string required: - id - content - role - status title: ConversationMessage type: object DatasetPurpose: description: Purpose of the dataset. Each purpose has a required input data schema. enum: - post-training/messages - eval/question-answer - eval/messages-answer title: DatasetPurpose type: string Dataset: description: Dataset resource for storing and accessing training or evaluation data. properties: identifier: description: Unique identifier for this resource in llama stack title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: const: dataset default: dataset title: Type type: string purpose: $ref: '#/components/schemas/DatasetPurpose' source: discriminator: mapping: rows: '#/components/schemas/RowsDataSource' uri: '#/components/schemas/URIDataSource' propertyName: type oneOf: - $ref: '#/components/schemas/URIDataSource' title: URIDataSource - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource metadata: additionalProperties: true description: Any additional metadata for this dataset title: Metadata type: object required: - identifier - provider_id - purpose - source title: Dataset type: object ListDatasetsResponse: description: Response from listing datasets. properties: data: items: $ref: '#/components/schemas/Dataset' title: Data type: array required: - data title: ListDatasetsResponse type: object Error: description: Error response from the API. Roughly follows RFC 7807. properties: status: title: Status type: integer title: title: Title type: string detail: title: Detail type: string instance: anyOf: - type: string - type: 'null' nullable: true required: - status - title - detail title: Error type: object Api: description: Enumeration of all available APIs in the Llama Stack system. enum: - providers - inference - safety - agents - batches - vector_io - datasetio - scoring - eval - post_training - tool_runtime - models - shields - vector_stores - datasets - scoring_functions - benchmarks - tool_groups - files - prompts - conversations - inspect title: Api type: string InlineProviderSpec: properties: api: $ref: '#/components/schemas/Api' provider_type: title: Provider Type type: string config_class: description: Fully-qualified classname of the config for this provider title: Config Class type: string api_dependencies: description: Higher-level API surfaces may depend on other providers to provide their functionality items: $ref: '#/components/schemas/Api' title: Api Dependencies type: array optional_api_dependencies: items: $ref: '#/components/schemas/Api' title: Optional Api Dependencies type: array deprecation_warning: anyOf: - type: string - type: 'null' description: If this provider is deprecated, specify the warning message here nullable: true deprecation_error: anyOf: - type: string - type: 'null' description: If this provider is deprecated and does NOT work, specify the error message here nullable: true module: anyOf: - type: string - type: 'null' description: |2- Fully-qualified name of the module to import. The module is expected to have: - `get_adapter_impl(config, deps)`: returns the adapter implementation Example: `module: ramalama_stack` nullable: true pip_packages: description: The pip dependencies needed for this implementation items: type: string title: Pip Packages type: array provider_data_validator: anyOf: - type: string - type: 'null' nullable: true is_external: default: false description: Notes whether this provider is an external provider. title: Is External type: boolean deps__: items: type: string title: Deps type: array container_image: anyOf: - type: string - type: 'null' description: |2 The container image to use for this implementation. If one is provided, pip_packages will be ignored. If a provider depends on other providers, the dependencies MUST NOT specify a container image. nullable: true description: anyOf: - type: string - type: 'null' description: |2 A description of the provider. This is used to display in the documentation. nullable: true required: - api - provider_type - config_class title: InlineProviderSpec type: object ModelType: description: Enumeration of supported model types in Llama Stack. enum: - llm - embedding - rerank title: ModelType type: string Model: description: A model resource representing an AI model registered in Llama Stack. properties: identifier: description: Unique identifier for this resource in llama stack title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: const: model default: model title: Type type: string metadata: additionalProperties: true description: Any additional metadata for this model title: Metadata type: object model_type: $ref: '#/components/schemas/ModelType' default: llm required: - identifier - provider_id title: Model type: object ProviderSpec: properties: api: $ref: '#/components/schemas/Api' provider_type: title: Provider Type type: string config_class: description: Fully-qualified classname of the config for this provider title: Config Class type: string api_dependencies: description: Higher-level API surfaces may depend on other providers to provide their functionality items: $ref: '#/components/schemas/Api' title: Api Dependencies type: array optional_api_dependencies: items: $ref: '#/components/schemas/Api' title: Optional Api Dependencies type: array deprecation_warning: anyOf: - type: string - type: 'null' description: If this provider is deprecated, specify the warning message here nullable: true deprecation_error: anyOf: - type: string - type: 'null' description: If this provider is deprecated and does NOT work, specify the error message here nullable: true module: anyOf: - type: string - type: 'null' description: |2- Fully-qualified name of the module to import. The module is expected to have: - `get_adapter_impl(config, deps)`: returns the adapter implementation Example: `module: ramalama_stack` nullable: true pip_packages: description: The pip dependencies needed for this implementation items: type: string title: Pip Packages type: array provider_data_validator: anyOf: - type: string - type: 'null' nullable: true is_external: default: false description: Notes whether this provider is an external provider. title: Is External type: boolean deps__: items: type: string title: Deps type: array required: - api - provider_type - config_class title: ProviderSpec type: object RemoteProviderSpec: properties: api: $ref: '#/components/schemas/Api' provider_type: title: Provider Type type: string config_class: description: Fully-qualified classname of the config for this provider title: Config Class type: string api_dependencies: description: Higher-level API surfaces may depend on other providers to provide their functionality items: $ref: '#/components/schemas/Api' title: Api Dependencies type: array optional_api_dependencies: items: $ref: '#/components/schemas/Api' title: Optional Api Dependencies type: array deprecation_warning: anyOf: - type: string - type: 'null' description: If this provider is deprecated, specify the warning message here nullable: true deprecation_error: anyOf: - type: string - type: 'null' description: If this provider is deprecated and does NOT work, specify the error message here nullable: true module: anyOf: - type: string - type: 'null' description: |2- Fully-qualified name of the module to import. The module is expected to have: - `get_adapter_impl(config, deps)`: returns the adapter implementation Example: `module: ramalama_stack` nullable: true pip_packages: description: The pip dependencies needed for this implementation items: type: string title: Pip Packages type: array provider_data_validator: anyOf: - type: string - type: 'null' nullable: true is_external: default: false description: Notes whether this provider is an external provider. title: Is External type: boolean deps__: items: type: string title: Deps type: array adapter_type: description: Unique identifier for this adapter title: Adapter Type type: string description: anyOf: - type: string - type: 'null' description: |2 A description of the provider. This is used to display in the documentation. nullable: true required: - api - provider_type - config_class - adapter_type title: RemoteProviderSpec type: object ScoringFn: description: A scoring function resource for evaluating model outputs. properties: identifier: description: Unique identifier for this resource in llama stack title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: const: scoring_function default: scoring_function title: Type type: string description: anyOf: - type: string - type: 'null' nullable: true metadata: additionalProperties: true description: Any additional metadata for this definition title: Metadata type: object return_type: description: The return type of the deterministic function discriminator: mapping: array: '#/components/schemas/ArrayType' boolean: '#/components/schemas/BooleanType' chat_completion_input: '#/components/schemas/ChatCompletionInputType' completion_input: '#/components/schemas/CompletionInputType' json: '#/components/schemas/JsonType' number: '#/components/schemas/NumberType' object: '#/components/schemas/ObjectType' string: '#/components/schemas/StringType' union: '#/components/schemas/UnionType' propertyName: type oneOf: - $ref: '#/components/schemas/StringType' title: StringType - $ref: '#/components/schemas/NumberType' title: NumberType - $ref: '#/components/schemas/BooleanType' title: BooleanType - $ref: '#/components/schemas/ArrayType' title: ArrayType - $ref: '#/components/schemas/ObjectType' title: ObjectType - $ref: '#/components/schemas/JsonType' title: JsonType - $ref: '#/components/schemas/UnionType' title: UnionType - $ref: '#/components/schemas/ChatCompletionInputType' title: ChatCompletionInputType - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) params: anyOf: - discriminator: mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' propertyName: type oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: 'null' description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval title: Params nullable: true required: - identifier - provider_id - return_type title: ScoringFn type: object Shield: description: A safety shield resource that can be used to check content. properties: identifier: description: Unique identifier for this resource in llama stack title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: const: shield default: shield title: Type type: string params: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true required: - identifier - provider_id title: Shield type: object ToolGroup: description: A group of related tools managed together. properties: identifier: description: Unique identifier for this resource in llama stack title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: const: tool_group default: tool_group title: Type type: string mcp_endpoint: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' nullable: true title: URL args: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true required: - identifier - provider_id title: ToolGroup type: object ModelCandidate: description: A model candidate for evaluation. properties: type: const: model default: model title: Type type: string model: title: Model type: string sampling_params: $ref: '#/components/schemas/SamplingParams' system_message: anyOf: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' nullable: true title: SystemMessage required: - model - sampling_params title: ModelCandidate type: object SamplingParams: description: Sampling parameters. properties: strategy: discriminator: mapping: greedy: '#/components/schemas/GreedySamplingStrategy' top_k: '#/components/schemas/TopKSamplingStrategy' top_p: '#/components/schemas/TopPSamplingStrategy' propertyName: type oneOf: - $ref: '#/components/schemas/GreedySamplingStrategy' title: GreedySamplingStrategy - $ref: '#/components/schemas/TopPSamplingStrategy' title: TopPSamplingStrategy - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy max_tokens: anyOf: - type: integer - type: 'null' nullable: true repetition_penalty: anyOf: - type: number - type: 'null' default: 1.0 stop: anyOf: - items: type: string type: array - type: 'null' nullable: true title: SamplingParams type: object SystemMessage: description: A system message providing instructions or context to the model. properties: role: const: system default: system title: Role type: string content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] required: - content title: SystemMessage type: object BenchmarkConfig: description: A benchmark configuration for evaluation. properties: eval_candidate: $ref: '#/components/schemas/ModelCandidate' scoring_params: additionalProperties: discriminator: mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' propertyName: type oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams description: Map between scoring function id and parameters for each scoring function you want to run title: Scoring Params type: object num_examples: anyOf: - type: integer - type: 'null' description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated nullable: true required: - eval_candidate title: BenchmarkConfig type: object ScoringResult: description: A scoring result for a single row. properties: score_rows: items: additionalProperties: true type: object title: Score Rows type: array aggregated_results: additionalProperties: true title: Aggregated Results type: object required: - score_rows - aggregated_results title: ScoringResult type: object EvaluateResponse: description: The response from an evaluation. properties: generations: items: additionalProperties: true type: object title: Generations type: array scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' title: Scores type: object required: - generations - scores title: EvaluateResponse type: object ExpiresAfter: description: |- Control expiration of uploaded files. Params: - anchor, must be "created_at" - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) properties: anchor: const: created_at title: Anchor type: string seconds: maximum: 2592000 minimum: 3600 title: Seconds type: integer required: - anchor - seconds title: ExpiresAfter type: object OpenAIFileObject: description: OpenAI File object as defined in the OpenAI Files API. properties: object: const: file default: file title: Object type: string id: title: Id type: string bytes: title: Bytes type: integer created_at: title: Created At type: integer expires_at: title: Expires At type: integer filename: title: Filename type: string purpose: $ref: '#/components/schemas/OpenAIFilePurpose' required: - id - bytes - created_at - expires_at - filename - purpose title: OpenAIFileObject type: object OpenAIFilePurpose: description: Valid purpose values for OpenAI Files API. enum: - assistants - batch title: OpenAIFilePurpose type: string ListOpenAIFileResponse: description: Response for listing files in OpenAI Files API. properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' title: Data type: array has_more: title: Has More type: boolean first_id: title: First Id type: string last_id: title: Last Id type: string object: const: list default: list title: Object type: string required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse type: object OpenAIFileDeleteResponse: description: Response for deleting a file in OpenAI Files API. properties: id: title: Id type: string object: const: file default: file title: Object type: string deleted: title: Deleted type: boolean required: - id - deleted title: OpenAIFileDeleteResponse type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: type: const: bf16 default: bf16 title: Type type: string title: Bf16QuantizationConfig type: object EmbeddingsResponse: description: Response containing generated embeddings. properties: embeddings: items: items: type: number type: array title: Embeddings type: array required: - embeddings title: EmbeddingsResponse type: object Fp8QuantizationConfig: description: Configuration for 8-bit floating point quantization. properties: type: const: fp8_mixed default: fp8_mixed title: Type type: string title: Fp8QuantizationConfig type: object Int4QuantizationConfig: description: Configuration for 4-bit integer quantization. properties: type: const: int4_mixed default: int4_mixed title: Type type: string scheme: anyOf: - type: string - type: 'null' default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig type: object OpenAIChatCompletionUsage: description: Usage information for OpenAI chat completion. properties: prompt_tokens: title: Prompt Tokens type: integer completion_tokens: title: Completion Tokens type: integer total_tokens: title: Total Tokens type: integer prompt_tokens_details: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' title: OpenAIChatCompletionUsagePromptTokensDetails - type: 'null' nullable: true title: OpenAIChatCompletionUsagePromptTokensDetails completion_tokens_details: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' title: OpenAIChatCompletionUsageCompletionTokensDetails - type: 'null' nullable: true title: OpenAIChatCompletionUsageCompletionTokensDetails required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage type: object OpenAIChatCompletionUsageCompletionTokensDetails: description: Token details for output tokens in OpenAI chat completion usage. properties: reasoning_tokens: anyOf: - type: integer - type: 'null' nullable: true title: OpenAIChatCompletionUsageCompletionTokensDetails type: object OpenAIChatCompletionUsagePromptTokensDetails: description: Token details for prompt tokens in OpenAI chat completion usage. properties: cached_tokens: anyOf: - type: integer - type: 'null' nullable: true title: OpenAIChatCompletionUsagePromptTokensDetails type: object OpenAIChoice: description: A choice from an OpenAI-compatible chat completion response. properties: message: discriminator: mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' propertyName: role oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam' title: OpenAIAssistantMessageParam - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) finish_reason: title: Finish Reason type: string index: title: Index type: integer logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' nullable: true title: OpenAIChoiceLogprobs required: - message - finish_reason - index title: OpenAIChoice type: object OpenAIChoiceLogprobs: description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. properties: content: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' nullable: true refusal: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' nullable: true title: OpenAIChoiceLogprobs type: object OpenAICompletionWithInputMessages: properties: id: title: Id type: string choices: items: $ref: '#/components/schemas/OpenAIChoice' title: Choices type: array object: const: chat.completion default: chat.completion title: Object type: string created: title: Created type: integer model: title: Model type: string usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' nullable: true title: OpenAIChatCompletionUsage input_messages: items: discriminator: mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' propertyName: role oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam' title: OpenAIAssistantMessageParam - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) title: Input Messages type: array required: - id - choices - created - model - input_messages title: OpenAICompletionWithInputMessages type: object OpenAITokenLogProb: description: |- The log probability for a token from an OpenAI-compatible chat completion response. :token: The token :bytes: (Optional) The bytes for the token :logprob: The log probability of the token :top_logprobs: The top log probabilities for the token properties: token: title: Token type: string bytes: anyOf: - items: type: integer type: array - type: 'null' nullable: true logprob: title: Logprob type: number top_logprobs: items: $ref: '#/components/schemas/OpenAITopLogProb' title: Top Logprobs type: array required: - token - logprob - top_logprobs title: OpenAITokenLogProb type: object OpenAITopLogProb: description: |- The top log probability for a token from an OpenAI-compatible chat completion response. :token: The token :bytes: (Optional) The bytes for the token :logprob: The log probability of the token properties: token: title: Token type: string bytes: anyOf: - items: type: integer type: array - type: 'null' nullable: true logprob: title: Logprob type: number required: - token - logprob title: OpenAITopLogProb type: object ListOpenAIChatCompletionResponse: description: Response from listing OpenAI-compatible chat completions. properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' title: Data type: array has_more: title: Has More type: boolean first_id: title: First Id type: string last_id: title: Last Id type: string object: const: list default: list title: Object type: string required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse type: object OpenAIChatCompletion: description: Response from an OpenAI-compatible chat completion request. properties: id: title: Id type: string choices: items: $ref: '#/components/schemas/OpenAIChoice' title: Choices type: array object: const: chat.completion default: chat.completion title: Object type: string created: title: Created type: integer model: title: Model type: string usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' nullable: true title: OpenAIChatCompletionUsage required: - id - choices - created - model title: OpenAIChatCompletion type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: content: anyOf: - type: string - type: 'null' nullable: true refusal: anyOf: - type: string - type: 'null' nullable: true role: anyOf: - type: string - type: 'null' nullable: true tool_calls: anyOf: - items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' type: array - type: 'null' nullable: true reasoning_content: anyOf: - type: string - type: 'null' nullable: true title: OpenAIChoiceDelta type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: delta: $ref: '#/components/schemas/OpenAIChoiceDelta' finish_reason: title: Finish Reason type: string index: title: Index type: integer logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' nullable: true title: OpenAIChoiceLogprobs required: - delta - finish_reason - index title: OpenAIChunkChoice type: object OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: id: title: Id type: string choices: items: $ref: '#/components/schemas/OpenAIChunkChoice' title: Choices type: array object: const: chat.completion.chunk default: chat.completion.chunk title: Object type: string created: title: Created type: integer model: title: Model type: string usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' nullable: true title: OpenAIChatCompletionUsage required: - id - choices - created - model title: OpenAIChatCompletionChunk type: object OpenAIChatCompletionRequestWithExtraBody: additionalProperties: true description: Request parameters for OpenAI-compatible chat completion endpoint. properties: model: title: Model type: string messages: items: discriminator: mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' propertyName: role oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam' title: OpenAIAssistantMessageParam - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) minItems: 1 title: Messages type: array frequency_penalty: anyOf: - type: number - type: 'null' nullable: true function_call: anyOf: - type: string - additionalProperties: true type: object - type: 'null' title: string | object nullable: true functions: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' nullable: true logit_bias: anyOf: - additionalProperties: type: number type: object - type: 'null' nullable: true logprobs: anyOf: - type: boolean - type: 'null' nullable: true max_completion_tokens: anyOf: - type: integer - type: 'null' nullable: true max_tokens: anyOf: - type: integer - type: 'null' nullable: true n: anyOf: - type: integer - type: 'null' nullable: true parallel_tool_calls: anyOf: - type: boolean - type: 'null' nullable: true presence_penalty: anyOf: - type: number - type: 'null' nullable: true response_format: anyOf: - discriminator: mapping: json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' text: '#/components/schemas/OpenAIResponseFormatText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format nullable: true seed: anyOf: - type: integer - type: 'null' nullable: true stop: anyOf: - type: string - items: type: string type: array title: list[string] - type: 'null' title: string | list[string] nullable: true stream: anyOf: - type: boolean - type: 'null' nullable: true stream_options: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true temperature: anyOf: - type: number - type: 'null' nullable: true tool_choice: anyOf: - type: string - additionalProperties: true type: object - type: 'null' title: string | object nullable: true tools: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' nullable: true top_logprobs: anyOf: - type: integer - type: 'null' nullable: true top_p: anyOf: - type: number - type: 'null' nullable: true user: anyOf: - type: string - type: 'null' nullable: true required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody type: object OpenAICompletionChoice: description: |- A choice from an OpenAI-compatible completion response. :finish_reason: The reason the model stopped generating :text: The text of the choice :index: The index of the choice :logprobs: (Optional) The log probabilities for the tokens in the choice properties: finish_reason: title: Finish Reason type: string text: title: Text type: string index: title: Index type: integer logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' nullable: true title: OpenAIChoiceLogprobs required: - finish_reason - text - index title: OpenAICompletionChoice type: object OpenAICompletion: description: |- Response from an OpenAI-compatible completion request. :id: The ID of the completion :choices: List of choices :created: The Unix timestamp in seconds when the completion was created :model: The model that was used to generate the completion :object: The object type, which will be "text_completion" properties: id: title: Id type: string choices: items: $ref: '#/components/schemas/OpenAICompletionChoice' title: Choices type: array created: title: Created type: integer model: title: Model type: string object: const: text_completion default: text_completion title: Object type: string required: - id - choices - created - model title: OpenAICompletion type: object OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. :text_offset: (Optional) The offset of the token in the text :token_logprobs: (Optional) The log probabilities for the tokens :tokens: (Optional) The tokens :top_logprobs: (Optional) The top log probabilities for the tokens properties: text_offset: anyOf: - items: type: integer type: array - type: 'null' nullable: true token_logprobs: anyOf: - items: type: number type: array - type: 'null' nullable: true tokens: anyOf: - items: type: string type: array - type: 'null' nullable: true top_logprobs: anyOf: - items: additionalProperties: type: number type: object type: array - type: 'null' nullable: true title: OpenAICompletionLogprobs type: object OpenAICompletionRequestWithExtraBody: additionalProperties: true description: Request parameters for OpenAI-compatible completion endpoint. properties: model: title: Model type: string prompt: anyOf: - type: string - items: type: string type: array title: list[string] - items: type: integer type: array title: list[integer] - items: items: type: integer type: array type: array title: list[array] title: string | ... (4 variants) best_of: anyOf: - type: integer - type: 'null' nullable: true echo: anyOf: - type: boolean - type: 'null' nullable: true frequency_penalty: anyOf: - type: number - type: 'null' nullable: true logit_bias: anyOf: - additionalProperties: type: number type: object - type: 'null' nullable: true logprobs: anyOf: - type: boolean - type: 'null' nullable: true max_tokens: anyOf: - type: integer - type: 'null' nullable: true n: anyOf: - type: integer - type: 'null' nullable: true presence_penalty: anyOf: - type: number - type: 'null' nullable: true seed: anyOf: - type: integer - type: 'null' nullable: true stop: anyOf: - type: string - items: type: string type: array title: list[string] - type: 'null' title: string | list[string] nullable: true stream: anyOf: - type: boolean - type: 'null' nullable: true stream_options: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true temperature: anyOf: - type: number - type: 'null' nullable: true top_p: anyOf: - type: number - type: 'null' nullable: true user: anyOf: - type: string - type: 'null' nullable: true suffix: anyOf: - type: string - type: 'null' nullable: true required: - model - prompt title: OpenAICompletionRequestWithExtraBody type: object OpenAIEmbeddingData: description: A single embedding data object from an OpenAI-compatible embeddings response. properties: object: const: embedding default: embedding title: Object type: string embedding: anyOf: - items: type: number type: array title: list[number] - type: string title: list[number] | string index: title: Index type: integer required: - embedding - index title: OpenAIEmbeddingData type: object OpenAIEmbeddingUsage: description: Usage information for an OpenAI-compatible embeddings response. properties: prompt_tokens: title: Prompt Tokens type: integer total_tokens: title: Total Tokens type: integer required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage type: object OpenAIEmbeddingsRequestWithExtraBody: additionalProperties: true description: Request parameters for OpenAI-compatible embeddings endpoint. properties: model: title: Model type: string input: anyOf: - type: string - items: type: string type: array title: list[string] title: string | list[string] encoding_format: anyOf: - type: string - type: 'null' default: float dimensions: anyOf: - type: integer - type: 'null' nullable: true user: anyOf: - type: string - type: 'null' nullable: true required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody type: object OpenAIEmbeddingsResponse: description: Response from an OpenAI-compatible embeddings request. properties: object: const: list default: list title: Object type: string data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' title: Data type: array model: title: Model type: string usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' required: - data - model - usage title: OpenAIEmbeddingsResponse type: object RerankData: description: A single rerank result from a reranking response. properties: index: title: Index type: integer relevance_score: title: Relevance Score type: number required: - index - relevance_score title: RerankData type: object RerankResponse: description: Response from a reranking request. properties: data: items: $ref: '#/components/schemas/RerankData' title: Data type: array required: - data title: RerankResponse type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: logprobs_by_token: additionalProperties: type: number title: Logprobs By Token type: object required: - logprobs_by_token title: TokenLogProbs type: object ToolResponseMessage: description: A message representing the result of a tool invocation. properties: role: const: tool default: tool title: Role type: string call_id: title: Call Id type: string content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] required: - call_id - content title: ToolResponseMessage type: object UserMessage: description: A message from the user in a chat conversation. properties: role: const: user default: user title: Role type: string content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] context: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] - type: 'null' title: string | list[ImageContentItem | TextContentItem] nullable: true required: - content title: UserMessage type: object HealthStatus: enum: - OK - Error - Not Implemented title: HealthStatus type: string HealthInfo: description: Health status information for the service. properties: status: $ref: '#/components/schemas/HealthStatus' required: - status title: HealthInfo type: object RouteInfo: description: Information about an API route including its path, method, and implementing providers. properties: route: title: Route type: string method: title: Method type: string provider_types: items: type: string title: Provider Types type: array required: - route - method - provider_types title: RouteInfo type: object ListRoutesResponse: description: Response containing a list of all available API routes. properties: data: items: $ref: '#/components/schemas/RouteInfo' title: Data type: array required: - data title: ListRoutesResponse type: object VersionInfo: description: Version information for the service. properties: version: title: Version type: string required: - version title: VersionInfo type: object OpenAIModel: description: |- A model from OpenAI. :id: The ID of the model :object: The object type, which will be "model" :created: The Unix timestamp in seconds when the model was created :owned_by: The owner of the model :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata properties: id: title: Id type: string object: const: model default: model title: Object type: string created: title: Created type: integer owned_by: title: Owned By type: string custom_metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true required: - id - created - owned_by title: OpenAIModel type: object OpenAIListModelsResponse: properties: data: items: $ref: '#/components/schemas/OpenAIModel' title: Data type: array required: - data title: OpenAIListModelsResponse type: object DPOLossType: enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType type: string DPOAlignmentConfig: description: Configuration for Direct Preference Optimization (DPO) alignment. properties: beta: title: Beta type: number loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid required: - beta title: DPOAlignmentConfig type: object DatasetFormat: description: Format of the training dataset. enum: - instruct - dialog title: DatasetFormat type: string DataConfig: description: Configuration for training data and data loading. properties: dataset_id: title: Dataset Id type: string batch_size: title: Batch Size type: integer shuffle: title: Shuffle type: boolean data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' nullable: true packed: anyOf: - type: boolean - type: 'null' default: false train_on_input: anyOf: - type: boolean - type: 'null' default: false required: - dataset_id - batch_size - shuffle - data_format title: DataConfig type: object EfficiencyConfig: description: Configuration for memory and compute efficiency optimizations. properties: enable_activation_checkpointing: anyOf: - type: boolean - type: 'null' default: false enable_activation_offloading: anyOf: - type: boolean - type: 'null' default: false memory_efficient_fsdp_wrap: anyOf: - type: boolean - type: 'null' default: false fsdp_cpu_offload: anyOf: - type: boolean - type: 'null' default: false title: EfficiencyConfig type: object PostTrainingJob: properties: job_uuid: title: Job Uuid type: string required: - job_uuid title: PostTrainingJob type: object ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' title: Data type: array required: - data title: ListPostTrainingJobsResponse type: object OptimizerType: description: Available optimizer algorithms for training. enum: - adam - adamw - sgd title: OptimizerType type: string OptimizerConfig: description: Configuration parameters for the optimization algorithm. properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: title: Lr type: number weight_decay: title: Weight Decay type: number num_warmup_steps: title: Num Warmup Steps type: integer required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig type: object PostTrainingJobArtifactsResponse: description: Artifacts of a finetuning job. properties: job_uuid: title: Job Uuid type: string checkpoints: items: $ref: '#/components/schemas/Checkpoint' title: Checkpoints type: array required: - job_uuid title: PostTrainingJobArtifactsResponse type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: job_uuid: title: Job Uuid type: string log_lines: items: type: string title: Log Lines type: array required: - job_uuid - log_lines title: PostTrainingJobLogStream type: object PostTrainingJobStatusResponse: description: Status of a finetuning job. properties: job_uuid: title: Job Uuid type: string status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - format: date-time type: string - type: 'null' nullable: true started_at: anyOf: - format: date-time type: string - type: 'null' nullable: true completed_at: anyOf: - format: date-time type: string - type: 'null' nullable: true resources_allocated: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true checkpoints: items: $ref: '#/components/schemas/Checkpoint' title: Checkpoints type: array required: - job_uuid - status title: PostTrainingJobStatusResponse type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string TrainingConfig: description: Comprehensive configuration for the training process. properties: n_epochs: title: N Epochs type: integer max_steps_per_epoch: default: 1 title: Max Steps Per Epoch type: integer gradient_accumulation_steps: default: 1 title: Gradient Accumulation Steps type: integer max_validation_steps: anyOf: - type: integer - type: 'null' default: 1 data_config: anyOf: - $ref: '#/components/schemas/DataConfig' title: DataConfig - type: 'null' nullable: true title: DataConfig optimizer_config: anyOf: - $ref: '#/components/schemas/OptimizerConfig' title: OptimizerConfig - type: 'null' nullable: true title: OptimizerConfig efficiency_config: anyOf: - $ref: '#/components/schemas/EfficiencyConfig' title: EfficiencyConfig - type: 'null' nullable: true title: EfficiencyConfig dtype: anyOf: - type: string - type: 'null' default: bf16 required: - n_epochs title: TrainingConfig type: object PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: job_uuid: title: Job Uuid type: string finetuned_model: $ref: '#/components/schemas/URL' dataset_id: title: Dataset Id type: string validation_dataset_id: title: Validation Dataset Id type: string algorithm: $ref: '#/components/schemas/RLHFAlgorithm' algorithm_config: $ref: '#/components/schemas/DPOAlignmentConfig' optimizer_config: $ref: '#/components/schemas/OptimizerConfig' training_config: $ref: '#/components/schemas/TrainingConfig' hyperparam_search_config: additionalProperties: true title: Hyperparam Search Config type: object logger_config: additionalProperties: true title: Logger Config type: object required: - job_uuid - finetuned_model - dataset_id - validation_dataset_id - algorithm - algorithm_config - optimizer_config - training_config - hyperparam_search_config - logger_config title: PostTrainingRLHFRequest type: object Prompt: description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. properties: prompt: anyOf: - type: string - type: 'null' description: The system prompt with variable placeholders nullable: true version: description: Version (integer starting at 1, incremented on save) minimum: 1 title: Version type: integer prompt_id: description: Unique identifier in format 'pmpt_<48-digit-hash>' title: Prompt Id type: string variables: description: List of variable names that can be used in the prompt template items: type: string title: Variables type: array is_default: default: false description: Boolean indicating whether this version is the default version title: Is Default type: boolean required: - version - prompt_id title: Prompt type: object ListPromptsResponse: description: Response model to list prompts. properties: data: items: $ref: '#/components/schemas/Prompt' title: Data type: array required: - data title: ListPromptsResponse type: object ProviderInfo: description: Information about a registered provider including its configuration and health status. properties: api: title: Api type: string provider_id: title: Provider Id type: string provider_type: title: Provider Type type: string config: additionalProperties: true title: Config type: object health: additionalProperties: true title: Health type: object required: - api - provider_id - provider_type - config - health title: ProviderInfo type: object ListProvidersResponse: description: Response containing a list of all available providers. properties: data: items: $ref: '#/components/schemas/ProviderInfo' title: Data type: array required: - data title: ListProvidersResponse type: object ModerationObjectResults: description: A moderation object. properties: flagged: title: Flagged type: boolean categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' nullable: true category_applied_input_types: anyOf: - additionalProperties: items: type: string type: array type: object - type: 'null' nullable: true category_scores: anyOf: - additionalProperties: type: number type: object - type: 'null' nullable: true user_message: anyOf: - type: string - type: 'null' nullable: true metadata: additionalProperties: true title: Metadata type: object required: - flagged title: ModerationObjectResults type: object ModerationObject: description: A moderation object. properties: id: title: Id type: string model: title: Model type: string results: items: $ref: '#/components/schemas/ModerationObjectResults' title: Results type: array required: - id - model - results title: ModerationObject type: object SafetyViolation: description: Details of a safety violation detected by content moderation. properties: violation_level: $ref: '#/components/schemas/ViolationLevel' user_message: anyOf: - type: string - type: 'null' nullable: true metadata: additionalProperties: true title: Metadata type: object required: - violation_level title: SafetyViolation type: object ViolationLevel: description: Severity level of a safety violation. enum: - info - warn - error title: ViolationLevel type: string RunShieldResponse: description: Response from running a safety shield. properties: violation: anyOf: - $ref: '#/components/schemas/SafetyViolation' title: SafetyViolation - type: 'null' nullable: true title: SafetyViolation title: RunShieldResponse type: object ScoreBatchResponse: description: Response from batch scoring operations on datasets. properties: dataset_id: anyOf: - type: string - type: 'null' nullable: true results: additionalProperties: $ref: '#/components/schemas/ScoringResult' title: Results type: object required: - results title: ScoreBatchResponse type: object ScoreResponse: description: The response from scoring. properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' title: Results type: object required: - results title: ScoreResponse type: object ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' title: Data type: array required: - data title: ListScoringFunctionsResponse type: object ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' title: Data type: array required: - data title: ListShieldsResponse type: object ToolDef: description: Tool definition used in runtime contexts. properties: toolgroup_id: anyOf: - type: string - type: 'null' nullable: true name: title: Name type: string description: anyOf: - type: string - type: 'null' nullable: true input_schema: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true output_schema: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true required: - name title: ToolDef type: object ListToolDefsResponse: description: Response containing a list of tool definitions. properties: data: items: $ref: '#/components/schemas/ToolDef' title: Data type: array required: - data title: ListToolDefsResponse type: object ListToolGroupsResponse: description: Response containing a list of tool groups. properties: data: items: $ref: '#/components/schemas/ToolGroup' title: Data type: array required: - data title: ListToolGroupsResponse type: object ToolGroupInput: description: Input data for registering a tool group. properties: toolgroup_id: title: Toolgroup Id type: string provider_id: title: Provider Id type: string args: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true mcp_endpoint: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' nullable: true title: URL required: - toolgroup_id - provider_id title: ToolGroupInput type: object ToolInvocationResult: description: Result of a tool invocation. properties: content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] - type: 'null' title: string | list[ImageContentItem | TextContentItem] nullable: true error_message: anyOf: - type: string - type: 'null' nullable: true error_code: anyOf: - type: integer - type: 'null' nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true title: ToolInvocationResult type: object ChunkMetadata: description: |- `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. Use `Chunk.metadata` for metadata that will be used in the context during inference. properties: chunk_id: anyOf: - type: string - type: 'null' nullable: true document_id: anyOf: - type: string - type: 'null' nullable: true source: anyOf: - type: string - type: 'null' nullable: true created_timestamp: anyOf: - type: integer - type: 'null' nullable: true updated_timestamp: anyOf: - type: integer - type: 'null' nullable: true chunk_window: anyOf: - type: string - type: 'null' nullable: true chunk_tokenizer: anyOf: - type: string - type: 'null' nullable: true chunk_embedding_model: anyOf: - type: string - type: 'null' nullable: true chunk_embedding_dimension: anyOf: - type: integer - type: 'null' nullable: true content_token_count: anyOf: - type: integer - type: 'null' nullable: true metadata_token_count: anyOf: - type: integer - type: 'null' nullable: true title: ChunkMetadata type: object Chunk: description: A chunk of content that can be inserted into a vector database. properties: content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] chunk_id: title: Chunk Id type: string metadata: additionalProperties: true title: Metadata type: object embedding: anyOf: - items: type: number type: array - type: 'null' nullable: true chunk_metadata: anyOf: - $ref: '#/components/schemas/ChunkMetadata' title: ChunkMetadata - type: 'null' nullable: true title: ChunkMetadata required: - content - chunk_id title: Chunk type: object OpenAICreateVectorStoreFileBatchRequestWithExtraBody: additionalProperties: true description: Request to create a vector store file batch with extra_body support. properties: file_ids: items: type: string title: File Ids type: array attributes: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true chunking_strategy: anyOf: - discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy nullable: true required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody type: object OpenAICreateVectorStoreRequestWithExtraBody: additionalProperties: true description: Request to create a vector store with extra_body support. properties: name: anyOf: - type: string - type: 'null' nullable: true file_ids: anyOf: - items: type: string type: array - type: 'null' nullable: true expires_after: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true chunking_strategy: anyOf: - discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true title: OpenAICreateVectorStoreRequestWithExtraBody type: object QueryChunksResponse: description: Response from querying chunks in a vector database. properties: chunks: items: $ref: '#/components/schemas/Chunk' title: Chunks type: array scores: items: type: number title: Scores type: array required: - chunks - scores title: QueryChunksResponse type: object VectorStoreContent: description: Content item from a vector store file or search result. properties: type: const: text title: Type type: string text: title: Text type: string embedding: anyOf: - items: type: number type: array - type: 'null' nullable: true chunk_metadata: anyOf: - $ref: '#/components/schemas/ChunkMetadata' title: ChunkMetadata - type: 'null' nullable: true title: ChunkMetadata metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true required: - type - text title: VectorStoreContent type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: name: anyOf: - type: string - type: 'null' nullable: true file_ids: items: type: string title: File Ids type: array expires_after: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true chunking_strategy: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true metadata: additionalProperties: true title: Metadata type: object title: VectorStoreCreateRequest type: object VectorStoreDeleteResponse: description: Response from deleting a vector store. properties: id: title: Id type: string object: default: vector_store.deleted title: Object type: string deleted: default: true title: Deleted type: boolean required: - id title: VectorStoreDeleteResponse type: object VectorStoreFileCounts: description: File processing status counts for a vector store. properties: completed: title: Completed type: integer cancelled: title: Cancelled type: integer failed: title: Failed type: integer in_progress: title: In Progress type: integer total: title: Total type: integer required: - completed - cancelled - failed - in_progress - total title: VectorStoreFileCounts type: object VectorStoreFileBatchObject: description: OpenAI Vector Store File Batch object. properties: id: title: Id type: string object: default: vector_store.file_batch title: Object type: string created_at: title: Created At type: integer vector_store_id: title: Vector Store Id type: string status: title: Status type: string enum: - completed - in_progress - cancelled - failed default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' required: - id - created_at - vector_store_id - status - file_counts title: VectorStoreFileBatchObject type: object VectorStoreFileContentResponse: description: Represents the parsed content of a vector store file. properties: object: const: vector_store.file_content.page default: vector_store.file_content.page title: Object type: string data: items: $ref: '#/components/schemas/VectorStoreContent' title: Data type: array has_more: default: false title: Has More type: boolean next_page: anyOf: - type: string - type: 'null' nullable: true required: - data title: VectorStoreFileContentResponse type: object VectorStoreFileDeleteResponse: description: Response from deleting a vector store file. properties: id: title: Id type: string object: default: vector_store.file.deleted title: Object type: string deleted: default: true title: Deleted type: boolean required: - id title: VectorStoreFileDeleteResponse type: object VectorStoreFileLastError: description: Error information for failed vector store file processing. properties: code: title: Code type: string enum: - server_error - rate_limit_exceeded default: server_error message: title: Message type: string required: - code - message title: VectorStoreFileLastError type: object VectorStoreFileObject: description: OpenAI Vector Store File object. properties: id: title: Id type: string object: default: vector_store.file title: Object type: string attributes: additionalProperties: true title: Attributes type: object chunking_strategy: discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic created_at: title: Created At type: integer last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' nullable: true title: VectorStoreFileLastError status: title: Status type: string enum: - completed - in_progress - cancelled - failed default: completed usage_bytes: default: 0 title: Usage Bytes type: integer vector_store_id: title: Vector Store Id type: string required: - id - chunking_strategy - created_at - status - vector_store_id title: VectorStoreFileObject type: object VectorStoreFilesListInBatchResponse: description: Response from listing files in a vector store file batch. properties: object: default: list title: Object type: string data: items: $ref: '#/components/schemas/VectorStoreFileObject' title: Data type: array first_id: anyOf: - type: string - type: 'null' nullable: true last_id: anyOf: - type: string - type: 'null' nullable: true has_more: default: false title: Has More type: boolean required: - data title: VectorStoreFilesListInBatchResponse type: object VectorStoreListFilesResponse: description: Response from listing files in a vector store. properties: object: default: list title: Object type: string data: items: $ref: '#/components/schemas/VectorStoreFileObject' title: Data type: array first_id: anyOf: - type: string - type: 'null' nullable: true last_id: anyOf: - type: string - type: 'null' nullable: true has_more: default: false title: Has More type: boolean required: - data title: VectorStoreListFilesResponse type: object VectorStoreObject: description: OpenAI Vector Store object. properties: id: title: Id type: string object: default: vector_store title: Object type: string created_at: title: Created At type: integer name: anyOf: - type: string - type: 'null' nullable: true usage_bytes: default: 0 title: Usage Bytes type: integer file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: default: completed title: Status type: string expires_after: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true expires_at: anyOf: - type: integer - type: 'null' nullable: true last_active_at: anyOf: - type: integer - type: 'null' nullable: true metadata: additionalProperties: true title: Metadata type: object required: - id - created_at - file_counts title: VectorStoreObject type: object VectorStoreListResponse: description: Response from listing vector stores. properties: object: default: list title: Object type: string data: items: $ref: '#/components/schemas/VectorStoreObject' title: Data type: array first_id: anyOf: - type: string - type: 'null' nullable: true last_id: anyOf: - type: string - type: 'null' nullable: true has_more: default: false title: Has More type: boolean required: - data title: VectorStoreListResponse type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: name: anyOf: - type: string - type: 'null' nullable: true expires_after: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true title: VectorStoreModifyRequest type: object VectorStoreSearchRequest: description: Request to search a vector store. properties: query: anyOf: - type: string - items: type: string type: array title: list[string] title: string | list[string] filters: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true max_num_results: default: 10 title: Max Num Results type: integer ranking_options: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true rewrite_query: default: false title: Rewrite Query type: boolean required: - query title: VectorStoreSearchRequest type: object VectorStoreSearchResponse: description: Response from searching a vector store. properties: file_id: title: File Id type: string filename: title: Filename type: string score: title: Score type: number attributes: anyOf: - additionalProperties: anyOf: - type: string - type: number - type: boolean title: string | number | boolean type: object - type: 'null' nullable: true content: items: $ref: '#/components/schemas/VectorStoreContent' title: Content type: array required: - file_id - filename - score - content title: VectorStoreSearchResponse type: object VectorStoreSearchResponsePage: description: Paginated response from searching a vector store. properties: object: default: vector_store.search_results.page title: Object type: string search_query: items: type: string title: Search Query type: array data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' title: Data type: array has_more: default: false title: Has More type: boolean next_page: anyOf: - type: string - type: 'null' nullable: true required: - search_query - data title: VectorStoreSearchResponsePage type: object