diff --git a/client-sdks/stainless/openapi.yml b/client-sdks/stainless/openapi.yml index d5324828a..1a55e80b6 100644 --- a/client-sdks/stainless/openapi.yml +++ b/client-sdks/stainless/openapi.yml @@ -16,39 +16,86 @@ servers: paths: /v1/batches: get: + responses: + '200': + description: A list of batch objects. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBatchesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Batches summary: List Batches + description: List all batches for the current user. operationId: list_batches_v1_batches_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + type: integer + default: 20 + title: Limit + post: responses: '200': - description: Successful Response + description: The created batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Batches summary: Create Batch + description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BatchesPostRequest' + /v1/batches/{batch_id}: + get: responses: '200': - description: Successful Response + description: The batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -61,30 +108,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/batches/{batch_id}: - get: tags: - Batches summary: Retrieve Batch + description: Retrieve information about a specific 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 @@ -94,16 +122,13 @@ paths: description: 'Path parameter: batch_id' /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 + description: The updated batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -116,6 +141,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Batches + summary: Cancel Batch + description: Cancel a batch that is in progress. + operationId: cancel_batch_v1_batches__batch_id__cancel_post parameters: - name: batch_id in: path @@ -125,39 +155,111 @@ paths: description: 'Path parameter: batch_id' /v1/chat/completions: get: + responses: + '200': + description: A ListOpenAIChatCompletionResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Inference summary: List Chat Completions + description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: model + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Model + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: An OpenAIChatCompletion. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIChatCompletion' + text/event-stream: + schema: + $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Inference summary: Openai Chat Completion + description: |- + Create chat completions. + + Generate an OpenAI-compatible chat completion for the given messages using the specified model. operationId: openai_chat_completion_v1_chat_completions_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' + /v1/chat/completions/{completion_id}: + get: responses: '200': - description: Successful Response + description: A OpenAICompletionWithInputMessages. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -170,30 +272,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/chat/completions/{completion_id}: - get: tags: - Inference summary: Get Chat Completion + description: |- + Get chat completion. + + Describe a chat completion by its ID. 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 @@ -203,16 +289,48 @@ paths: description: 'Path parameter: completion_id' /v1/completions: post: + responses: + '200': + description: An OpenAICompletion. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICompletion' + '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' tags: - Inference summary: Openai Completion + description: |- + Create completion. + + Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' + required: true + /v1/conversations: + post: responses: '200': - description: Successful Response + description: The created conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -225,18 +343,29 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/conversations: - post: tags: - Conversations summary: Create Conversation + description: |- + Create a conversation. + + Create a conversation. operationId: create_conversation_v1_conversations_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsPostRequest' + required: true + /v1/conversations/{conversation_id}: + get: responses: '200': - description: Successful Response + description: The conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -249,30 +378,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/conversations/{conversation_id}: - get: tags: - Conversations summary: Get Conversation + description: |- + Retrieve a conversation. + + Get a conversation with the given ID. 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 @@ -281,16 +394,13 @@ paths: 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 + description: The updated conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -303,6 +413,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Update Conversation + description: |- + Update a conversation. + + Update a conversation's metadata with the given ID. + operationId: update_conversation_v1_conversations__conversation_id__post parameters: - name: conversation_id in: path @@ -310,17 +428,20 @@ paths: schema: type: string description: 'Path parameter: conversation_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsByConversationIdPostRequest' + required: true delete: - tags: - - Conversations - summary: Openai Delete Conversation - operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': - description: Successful Response + description: The deleted conversation resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ConversationDeletedResource' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -333,6 +454,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Openai Delete Conversation + description: |- + Delete a conversation. + + Delete a conversation with the given ID. + operationId: openai_delete_conversation_v1_conversations__conversation_id__delete parameters: - name: conversation_id in: path @@ -342,58 +471,105 @@ paths: description: 'Path parameter: conversation_id' /v1/conversations/{conversation_id}/items: get: + responses: + '200': + description: List of conversation items. + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationItemList' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Conversations summary: List Items + description: |- + List items. + + List items in the conversation. 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - enum: + - asc + - desc + type: string + - type: 'null' + title: Order - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' + - name: include + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/ConversationItemInclude' + - type: 'null' + title: Include post: + responses: + '200': + description: List of created items. + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationItemList' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Conversations summary: Add Items + description: |- + Create items. + + Create items in the conversation. 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 @@ -401,18 +577,21 @@ paths: schema: type: string description: 'Path parameter: conversation_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsByConversationIdItemsPostRequest' /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 + description: The conversation item. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseMessage' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -425,6 +604,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Retrieve + description: |- + Retrieve an item. + + Retrieve a conversation item. + operationId: retrieve_v1_conversations__conversation_id__items__item_id__get parameters: - name: conversation_id in: path @@ -439,16 +626,13 @@ paths: 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 + description: The deleted item resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ConversationItemDeletedResource' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -461,6 +645,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Openai Delete Conversation Item + description: |- + Delete an item. + + Delete a conversation item. + operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete parameters: - name: conversation_id in: path @@ -476,63 +668,151 @@ paths: description: 'Path parameter: item_id' /v1/embeddings: post: + responses: + '200': + description: An OpenAIEmbeddingsResponse containing the embeddings. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIEmbeddingsResponse' + '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' tags: - Inference summary: Openai Embeddings + description: |- + Create embeddings. + + Generate OpenAI-compatible embeddings for the given input using the specified model. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' + required: true /v1/files: get: + responses: + '200': + description: An ListOpenAIFileResponse containing the list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIFileResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Files summary: Openai List Files + description: |- + List files. + + Returns a list of files that belong to the user's organization. operationId: openai_list_files_v1_files_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 10000 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + - name: purpose + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/OpenAIFilePurpose' + - type: 'null' + title: Purpose + post: responses: '200': - description: Successful Response + description: An OpenAIFileObject representing the uploaded file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileObject' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Files summary: Openai Upload File + description: |- + Upload file. + + Upload a file that can be used across various endpoints. + + The file upload should be a multipart form request with: + - file: The File object (not file name) to be uploaded. + - purpose: The intended purpose of the uploaded file. + - expires_after: Optional form values describing expiration for the file. operationId: openai_upload_file_v1_files_post + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Body_openai_upload_file_v1_files_post' + /v1/files/{file_id}: + get: responses: '200': - description: Successful Response + description: An OpenAIFileObject containing file information. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -545,30 +825,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/files/{file_id}: - get: tags: - Files summary: Openai Retrieve File + description: |- + Retrieve file. + + Returns information about a specific 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 @@ -577,16 +841,13 @@ paths: 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 + description: An OpenAIFileDeleteResponse indicating successful deletion. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -599,6 +860,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Files + summary: Openai Delete File + description: Delete file. + operationId: openai_delete_file_v1_files__file_id__delete parameters: - name: file_id in: path @@ -608,16 +874,13 @@ paths: description: 'Path parameter: file_id' /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 + description: The raw file content as a binary response. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Response' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -630,6 +893,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Files + summary: Openai Retrieve File Content + description: |- + Retrieve file content. + + Returns the contents of the specified file. + operationId: openai_retrieve_file_content_v1_files__file_id__content_get parameters: - name: file_id in: path @@ -639,40 +910,85 @@ paths: description: 'Path parameter: file_id' /v1/health: get: + responses: + '200': + description: Health information indicating if the service is operational. + content: + application/json: + schema: + $ref: '#/components/schemas/HealthInfo' + '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' tags: - Inspect summary: Health + description: |- + Get health status. + + Get the current health status of the service. 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: + responses: + '200': + description: Response containing information about all available routes. + content: + application/json: + schema: + $ref: '#/components/schemas/ListRoutesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Inspect summary: List Routes + description: |- + List routes. + + List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get + parameters: + - name: api_filter + in: query + required: false + schema: + anyOf: + - enum: + - v1 + - v1alpha + - v1beta + - deprecated + type: string + - type: 'null' + title: Api Filter + /v1/models: + get: responses: '200': - description: Successful Response + description: A OpenAIListModelsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIListModelsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -685,18 +1001,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/models: - get: tags: - Models summary: Openai List Models + description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get + post: responses: '200': - description: Successful Response + description: A Model. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Model' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -709,36 +1026,58 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Models summary: Register Model + description: |- + Register model. + + Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModelsPostRequest' + required: true deprecated: true /v1/models/{model_id}: get: + responses: + '200': + description: A Model. + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + '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' tags: - Models summary: Get Model + description: |- + Get model. + + Get a model by its identifier. operationId: get_model_v1_models__model_id__get + parameters: + - name: model_id + in: path + required: true + schema: + type: string + description: 'Path parameter: model_id' + delete: responses: '200': description: Successful Response @@ -757,37 +1096,14 @@ paths: 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 + description: |- + Unregister model. + + Unregister a 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 @@ -795,18 +1111,51 @@ paths: schema: type: string description: 'Path parameter: model_id' + deprecated: true /v1/moderations: post: + responses: + '200': + description: A moderation object. + content: + application/json: + schema: + $ref: '#/components/schemas/ModerationObject' + '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' tags: - Safety summary: Run Moderation + description: |- + Create moderation. + + Classifies if text and/or image inputs are potentially harmful. operationId: run_moderation_v1_moderations_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModerationsPostRequest' + required: true + /v1/prompts: + get: responses: '200': - description: Successful Response + description: A ListPromptsResponse containing all prompts. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -819,18 +1168,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/prompts: - get: tags: - Prompts summary: List Prompts + description: List all prompts. operationId: list_prompts_v1_prompts_get + post: responses: '200': - description: Successful Response + description: The created Prompt resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -843,54 +1193,58 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Prompts summary: Create Prompt + description: |- + Create prompt. + + Create a new 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsPostRequest' + required: true /v1/prompts/{prompt_id}: get: + responses: + '200': + description: A Prompt resource. + content: + application/json: + schema: + $ref: '#/components/schemas/Prompt' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Prompts summary: Get Prompt + description: |- + Get prompt. + + Get a prompt by its identifier and optional version. 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: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version - name: prompt_id in: path required: true @@ -898,28 +1252,33 @@ paths: type: string description: 'Path parameter: prompt_id' post: + responses: + '200': + description: The updated Prompt resource with incremented version. + content: + application/json: + schema: + $ref: '#/components/schemas/Prompt' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Prompts summary: Update Prompt + description: |- + Update prompt. + + Update an existing prompt (increments version). 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 @@ -927,11 +1286,13 @@ paths: schema: type: string description: 'Path parameter: prompt_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsByPromptIdPostRequest' delete: - tags: - - Prompts - summary: Delete Prompt - operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': description: Successful Response @@ -939,17 +1300,25 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' + description: Default Response + tags: + - Prompts + summary: Delete Prompt + description: |- + Delete prompt. + + Delete a prompt. + operationId: delete_prompt_v1_prompts__prompt_id__delete parameters: - name: prompt_id in: path @@ -959,16 +1328,13 @@ paths: 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 + description: The prompt with the specified version now set as default. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -981,6 +1347,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Prompts + summary: Set Default Version + description: |- + Set prompt version. + + Set which version of a prompt should be the default in get_prompt (latest). + operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post parameters: - name: prompt_id in: path @@ -988,18 +1362,21 @@ paths: schema: type: string description: 'Path parameter: prompt_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsByPromptIdSetDefaultVersionPostRequest' + required: true /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 + description: A ListPromptsResponse containing all versions of the prompt. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1012,6 +1389,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Prompts + summary: List Prompt Versions + description: |- + List prompt versions. + + List all versions of a specific prompt. + operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get parameters: - name: prompt_id in: path @@ -1021,16 +1406,42 @@ paths: description: 'Path parameter: prompt_id' /v1/providers: get: + responses: + '200': + description: A ListProvidersResponse containing information about all providers. + content: + application/json: + schema: + $ref: '#/components/schemas/ListProvidersResponse' + '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' tags: - Providers summary: List Providers + description: |- + List providers. + + List all available providers. operationId: list_providers_v1_providers_get + /v1/providers/{provider_id}: + get: responses: '200': - description: Successful Response + description: A ProviderInfo object containing the provider's details. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ProviderInfo' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1043,30 +1454,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/providers/{provider_id}: - get: tags: - Providers summary: Inspect Provider + description: |- + Get provider. + + Get detailed information about a specific 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 @@ -1076,39 +1471,132 @@ paths: description: 'Path parameter: provider_id' /v1/responses: get: + responses: + '200': + description: A ListOpenAIResponseObject. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIResponseObject' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Agents summary: List Openai Responses + description: List all responses. operationId: list_openai_responses_v1_responses_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 50 + title: Limit + - name: model + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Model + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: An OpenAIResponseObject. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseObject' + text/event-stream: + schema: + $ref: '#/components/schemas/OpenAIResponseObjectStream' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Agents summary: Create Openai Response + description: Create a model response. operationId: create_openai_response_v1_responses_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ResponsesPostRequest' + x-llama-stack-extra-body-params: + guardrails: + $defs: + ResponseGuardrailSpec: + description: |- + Specification for a guardrail to apply during response generation. + + :param type: The type/identifier of the guardrail. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + anyOf: + - items: + anyOf: + - type: string + - $ref: '#/components/schemas/ResponseGuardrailSpec' + type: array + - type: 'null' + description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation. + /v1/responses/{response_id}: + get: responses: '200': - description: Successful Response + description: An OpenAIResponseObject. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1121,30 +1609,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/responses/{response_id}: - get: tags: - Agents summary: Get Openai Response + description: Get a model 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 @@ -1153,16 +1622,13 @@ paths: 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 + description: An OpenAIDeleteResponseObject content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIDeleteResponseObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1175,6 +1641,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Agents + summary: Delete Openai Response + description: Delete a response. + operationId: delete_openai_response_v1_responses__response_id__delete parameters: - name: response_id in: path @@ -1184,65 +1655,143 @@ paths: description: 'Path parameter: response_id' /v1/responses/{response_id}/input_items: get: + responses: + '200': + description: An ListOpenAIResponseInputItem. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIResponseInputItem' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Agents summary: List Openai Response Input Items + description: List 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' + - name: include + in: query + required: false + schema: + anyOf: + - type: array + items: + type: string + - type: 'null' + title: Include /v1/safety/run-shield: post: + responses: + '200': + description: A RunShieldResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/RunShieldResponse' + '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' tags: - Safety summary: Run Shield + description: |- + Run shield. + + Run a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SafetyRunShieldPostRequest' + required: true /v1/scoring-functions: get: + responses: + '200': + description: A ListScoringFunctionsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListScoringFunctionsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Scoring Functions summary: List Scoring Functions + description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get + post: responses: '200': description: Successful Response @@ -1250,47 +1799,63 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Scoring Functions summary: Register Scoring Function + description: Register a 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_scoring_function_v1_scoring_functions_post' deprecated: true /v1/scoring-functions/{scoring_fn_id}: get: + responses: + '200': + description: A ScoringFn. + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringFn' + '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' tags: - Scoring Functions summary: Get Scoring Function + description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get + parameters: + - name: scoring_fn_id + in: path + required: true + schema: + type: string + description: 'Path parameter: scoring_fn_id' + delete: responses: '200': description: Successful Response @@ -1309,37 +1874,11 @@ paths: 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 + description: Unregister a 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 @@ -1347,18 +1886,48 @@ paths: schema: type: string description: 'Path parameter: scoring_fn_id' + deprecated: true /v1/scoring/score: post: + responses: + '200': + description: A ScoreResponse object containing rows and aggregated results. + content: + application/json: + schema: + $ref: '#/components/schemas/ScoreResponse' + '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' tags: - Scoring summary: Score + description: Score a list of rows. operationId: score_v1_scoring_score_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringScorePostRequest' + required: true + /v1/scoring/score-batch: + post: responses: '200': - description: Successful Response + description: A ScoreBatchResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ScoreBatchResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1371,18 +1940,26 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/scoring/score-batch: - post: tags: - Scoring summary: Score Batch + description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringScoreBatchPostRequest' + required: true + /v1/shields: + get: responses: '200': - description: Successful Response + description: A ListShieldsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListShieldsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1395,18 +1972,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/shields: - get: tags: - Shields summary: List Shields + description: List all shields. operationId: list_shields_v1_shields_get + post: responses: '200': - description: Successful Response + description: A Shield. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Shield' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1419,36 +1997,52 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Shields summary: Register Shield + description: Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldsPostRequest' + required: true deprecated: true /v1/shields/{identifier}: get: + responses: + '200': + description: A Shield. + content: + application/json: + schema: + $ref: '#/components/schemas/Shield' + '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' tags: - Shields summary: Get Shield + description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get + parameters: + - name: identifier + in: path + required: true + schema: + type: string + description: 'Path parameter: identifier' + delete: responses: '200': description: Successful Response @@ -1467,37 +2061,11 @@ paths: 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 + description: Unregister a 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 @@ -1505,60 +2073,117 @@ paths: schema: type: string description: 'Path parameter: identifier' + deprecated: true /v1/tool-runtime/invoke: post: + responses: + '200': + description: A ToolInvocationResult. + content: + application/json: + schema: + $ref: '#/components/schemas/ToolInvocationResult' + '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' tags: - Tool Runtime summary: Invoke Tool + description: Run a tool with the given arguments. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ToolRuntimeInvokePostRequest' + required: true /v1/tool-runtime/list-tools: get: + responses: + '200': + description: A ListToolDefsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolDefsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Runtime summary: List Runtime Tools + description: List all tools in the runtime. 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' + parameters: + - name: authorization + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + - name: tool_group_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Tool Group Id + - name: mcp_endpoint + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/URL' + - type: 'null' + title: Mcp Endpoint /v1/toolgroups: get: + responses: + '200': + description: A ListToolGroupsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolGroupsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tool Groups + description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get + post: responses: '200': description: Successful Response @@ -1566,53 +2191,37 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Tool Groups summary: Register Tool Group + description: Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_tool_group_v1_toolgroups_post' deprecated: true /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 + description: A ToolGroup. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ToolGroup' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1625,6 +2234,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Tool Groups + summary: Get Tool Group + description: Get a tool group by its ID. + operationId: get_tool_group_v1_toolgroups__toolgroup_id__get parameters: - name: toolgroup_id in: path @@ -1633,10 +2247,6 @@ paths: 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 @@ -1655,7 +2265,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - deprecated: true + tags: + - Tool Groups + summary: Unregister Toolgroup + description: Unregister a tool group. + operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete parameters: - name: toolgroup_id in: path @@ -1663,18 +2277,51 @@ paths: schema: type: string description: 'Path parameter: toolgroup_id' + deprecated: true /v1/tools: get: + responses: + '200': + description: A ListToolDefsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolDefsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tools + description: List tools with optional tool group. operationId: list_tools_v1_tools_get + parameters: + - name: toolgroup_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Toolgroup Id + /v1/tools/{tool_name}: + get: responses: '200': - description: Successful Response + description: A ToolDef. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ToolDef' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1687,30 +2334,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/tools/{tool_name}: - get: tags: - Tool Groups summary: Get Tool + description: Get a tool by its name. 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 @@ -1720,16 +2348,47 @@ paths: description: 'Path parameter: tool_name' /v1/vector-io/insert: post: + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Insert Chunks + description: Insert chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Chunk-Input' + title: Chunks + /v1/vector-io/query: + post: responses: '200': - description: Successful Response + description: A QueryChunksResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/QueryChunksResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1742,65 +2401,121 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/vector-io/query: - post: tags: - Vector Io summary: Query Chunks + description: Query chunks from a vector database. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorIoQueryPostRequest' + required: true /v1/vector_stores: get: + responses: + '200': + description: A VectorStoreListResponse containing the list of vector stores. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreListResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Vector Stores + description: Returns a list of vector stores. operationId: openai_list_vector_stores_v1_vector_stores_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: A VectorStoreObject representing the created vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Vector Io summary: Openai Create Vector Store + description: |- + Creates a vector store. + + Generate an OpenAI-compatible vector store with the given parameters. operationId: openai_create_vector_store_v1_vector_stores_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' + /v1/vector_stores/{vector_store_id}: + get: responses: '200': - description: Successful Response + description: A VectorStoreObject representing the vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1813,30 +2528,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/vector_stores/{vector_store_id}: - get: tags: - Vector Io summary: Openai Retrieve Vector Store + description: Retrieves a 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 @@ -1845,16 +2541,13 @@ paths: 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 + description: A VectorStoreObject representing the updated vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1867,6 +2560,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Update Vector Store + description: Updates a vector store. + operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post parameters: - name: vector_store_id in: path @@ -1874,17 +2572,20 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdPostRequest' + required: true 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 + description: A VectorStoreDeleteResponse indicating the deletion status. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1897,6 +2598,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Delete Vector Store + description: Delete a vector store. + operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete parameters: - name: vector_store_id in: path @@ -1906,16 +2612,13 @@ paths: description: 'Path parameter: vector_store_id' /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 + description: A VectorStoreFileBatchObject representing the created file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1928,6 +2631,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Create Vector Store File Batch + description: |- + Create a vector store file batch. + + Generate an OpenAI-compatible vector store file batch for the given vector store. + operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post parameters: - name: vector_store_id in: path @@ -1935,18 +2646,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' + required: true /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 + description: A VectorStoreFileBatchObject representing the file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1959,6 +2673,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Retrieve Vector Store File Batch + description: Retrieve a vector store file batch. + operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get parameters: - name: vector_store_id in: path @@ -1974,16 +2693,13 @@ paths: description: 'Path parameter: batch_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 + description: A VectorStoreFileBatchObject representing the cancelled file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1996,6 +2712,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Cancel Vector Store File Batch + description: Cancels a vector store file batch. + operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post parameters: - name: vector_store_id in: path @@ -2011,29 +2732,73 @@ paths: description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files: get: + responses: + '200': + description: A VectorStoreFilesListInBatchResponse containing the list of files in the batch. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Files In Vector Store File Batch + description: Returns a list of vector store files in a 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: filter + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Filter + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order - name: vector_store_id in: path required: true @@ -2048,29 +2813,78 @@ paths: description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/files: get: + responses: + '200': + description: A VectorStoreListFilesResponse containing the list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreListFilesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Files In Vector Store + description: List files in a 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: filter + in: query + required: false + schema: + title: Filter + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + nullable: true + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order - name: vector_store_id in: path required: true @@ -2078,28 +2892,30 @@ paths: type: string description: 'Path parameter: vector_store_id' post: + responses: + '200': + description: A VectorStoreFileObject representing the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileObject' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai Attach File To Vector Store + description: Attach a file to a 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 @@ -2107,18 +2923,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdFilesPostRequest' /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 + description: A VectorStoreFileObject representing the file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2131,6 +2950,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Retrieve Vector Store File + description: Retrieves a vector store file. + operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get parameters: - name: vector_store_id in: path @@ -2145,16 +2969,13 @@ paths: 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 + description: A VectorStoreFileObject representing the updated file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2167,6 +2988,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Update Vector Store File + description: Updates a vector store file. + operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post parameters: - name: vector_store_id in: path @@ -2180,17 +3006,20 @@ paths: schema: type: string description: 'Path parameter: file_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdFilesByFileIdPostRequest' + required: true 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 + description: A VectorStoreFileDeleteResponse indicating the deletion status. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2203,6 +3032,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Delete Vector Store File + description: Delete a vector store file. + operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete parameters: - name: vector_store_id in: path @@ -2218,29 +3052,49 @@ paths: description: 'Path parameter: file_id' /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: + responses: + '200': + description: File contents, optionally with embeddings and metadata based on query parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileContentResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai Retrieve Vector Store File Contents + description: Retrieves the contents of a vector store file. 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: include_embeddings + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + default: false + title: Include Embeddings + - name: include_metadata + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + default: false + title: Include Metadata - name: vector_store_id in: path required: true @@ -2255,16 +3109,13 @@ paths: 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 + description: A VectorStoreSearchResponse containing the search results. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreSearchResponsePage' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2277,6 +3128,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Search Vector Store + description: |- + Search for chunks in a vector store. + + Searches a vector store for relevant chunks based on a query and optional file attribute filters. + operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post parameters: - name: vector_store_id in: path @@ -2284,12 +3143,43 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdSearchPostRequest' + required: true /v1/version: get: + responses: + '200': + description: Version information containing the service version number. + content: + application/json: + schema: + $ref: '#/components/schemas/VersionInfo' + '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' tags: - Inspect summary: Version + description: |- + Get version. + + Get the version of the service. operationId: version_v1_version_get + /v1beta/datasetio/append-rows/{dataset_id}: + post: responses: '200': description: Successful Response @@ -2308,30 +3198,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1beta/datasetio/append-rows/{dataset_id}: - post: tags: - Datasetio summary: Append Rows + description: Append rows to a dataset. 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 @@ -2339,31 +3210,68 @@ paths: schema: type: string description: 'Path parameter: dataset_id' + requestBody: + content: + application/json: + schema: + items: + additionalProperties: true + type: object + type: array + title: Rows + required: true /v1beta/datasetio/iterrows/{dataset_id}: get: + responses: + '200': + description: A PaginatedResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Datasetio summary: Iterrows + description: |- + Get a paginated list of rows from a dataset. + + Uses offset-based pagination where: + - start_index: The starting index (0-based). If None, starts from beginning. + - limit: Number of items to return. If None or -1, returns all items. + + The response includes: + - data: List of items for the current page. + - has_more: Whether there are more items available after this set. 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: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: start_index + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Start Index - name: dataset_id in: path required: true @@ -2372,16 +3280,38 @@ paths: description: 'Path parameter: dataset_id' /v1beta/datasets: get: + responses: + '200': + description: A ListDatasetsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListDatasetsResponse' + '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' tags: - Datasets summary: List Datasets + description: List all datasets. operationId: list_datasets_v1beta_datasets_get + post: responses: '200': - description: Successful Response + description: A Dataset. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Dataset' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2394,36 +3324,52 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Datasets summary: Register Dataset + description: Register a new 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1BetaDatasetsPostRequestLoose' + required: true deprecated: true /v1beta/datasets/{dataset_id}: get: + responses: + '200': + description: A Dataset. + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + '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' tags: - Datasets summary: Get Dataset + description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get + parameters: + - name: dataset_id + in: path + required: true + schema: + type: string + description: 'Path parameter: dataset_id' + delete: responses: '200': description: Successful Response @@ -2442,37 +3388,11 @@ paths: 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 + description: Unregister a dataset by its ID. 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 @@ -2480,12 +3400,34 @@ paths: schema: type: string description: 'Path parameter: dataset_id' + deprecated: true /v1alpha/eval/benchmarks: get: + responses: + '200': + description: A ListBenchmarksResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBenchmarksResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Benchmarks summary: List Benchmarks + description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get + post: responses: '200': description: Successful Response @@ -2493,53 +3435,38 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Benchmarks summary: Register Benchmark + description: Register a 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_benchmark_v1alpha_eval_benchmarks_post' deprecated: true /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 + description: A Benchmark. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Benchmark' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2552,6 +3479,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Benchmarks + summary: Get Benchmark + description: Get a benchmark by its ID. + operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get parameters: - name: benchmark_id in: path @@ -2560,16 +3492,46 @@ paths: type: string description: 'Path parameter: 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' tags: - Benchmarks summary: Unregister Benchmark + description: Unregister a benchmark. operationId: unregister_benchmark_v1alpha_eval_benchmarks__benchmark_id__delete + parameters: + - name: benchmark_id + in: path + required: true + schema: + type: string + description: 'Path parameter: benchmark_id' + deprecated: true + /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: + post: responses: '200': - description: Successful Response + description: EvaluateResponse object containing generations and scores. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/EvaluateResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2582,26 +3544,33 @@ paths: 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/{benchmark_id}/evaluations: - post: tags: - Eval summary: Evaluate Rows + description: Evaluate a list of rows on a benchmark. operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post + parameters: + - name: benchmark_id + in: path + required: true + schema: + type: string + description: 'Path parameter: benchmark_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest' + required: true + /v1alpha/eval/benchmarks/{benchmark_id}/jobs: + post: responses: '200': - description: Successful Response + description: The job that was created to run the evaluation. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Job' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2614,37 +3583,11 @@ paths: 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: - post: tags: - Eval summary: Run Eval + description: Run an evaluation on a benchmark. 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 @@ -2652,18 +3595,21 @@ paths: schema: type: string description: 'Path parameter: benchmark_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BenchmarkConfig' + required: true /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 + description: The status of the evaluation job. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Job' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2676,6 +3622,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Status + description: Get the status of a job. + operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get parameters: - name: benchmark_id in: path @@ -2690,10 +3641,6 @@ paths: 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 @@ -2712,6 +3659,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Cancel + description: Cancel a job. + operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete parameters: - name: benchmark_id in: path @@ -2727,16 +3679,13 @@ paths: 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 + description: The result of the job. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/EvaluateResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2749,6 +3698,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Result + description: Get the result of a job. + operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get parameters: - name: benchmark_id in: path @@ -2764,34 +3718,71 @@ paths: description: 'Path parameter: job_id' /v1alpha/inference/rerank: post: + responses: + '200': + description: RerankResponse with indices sorted by relevance score (descending). + content: + application/json: + schema: + $ref: '#/components/schemas/RerankResponse' + '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' tags: - Inference summary: Rerank + description: Rerank a list of documents based on their relevance to a query. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaInferenceRerankPostRequest' + required: true /v1alpha/post-training/job/artifacts: get: + responses: + '200': + description: A PostTrainingJobArtifactsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Post Training summary: Get Training Job Artifacts + description: Get the artifacts of a training job. operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid + /v1alpha/post-training/job/cancel: + post: responses: '200': description: Successful Response @@ -2799,53 +3790,71 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/job/cancel: - post: + description: Default Response tags: - Post Training summary: Cancel Training Job + description: Cancel a 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' + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid /v1alpha/post-training/job/status: get: + responses: + '200': + description: A PostTrainingJobStatusResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PostTrainingJobStatusResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Post Training summary: Get Training Job Status + description: Get the status of a training job. operationId: get_training_job_status_v1alpha_post_training_job_status_get + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid + /v1alpha/post-training/jobs: + get: responses: '200': - description: Successful Response + description: A ListPostTrainingJobsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPostTrainingJobsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2858,18 +3867,20 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/jobs: - get: tags: - Post Training summary: Get Training Jobs + description: Get all training jobs. operationId: get_training_jobs_v1alpha_post_training_jobs_get + /v1alpha/post-training/preference-optimize: + post: responses: '200': - description: Successful Response + description: A PostTrainingJob. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/PostTrainingJob' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2882,18 +3893,26 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/preference-optimize: - post: tags: - Post Training summary: Preference Optimize + description: Run preference optimization of a model. operationId: preference_optimize_v1alpha_post_training_preference_optimize_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaPostTrainingPreferenceOptimizePostRequest' + required: true + /v1alpha/post-training/supervised-fine-tune: + post: responses: '200': - description: Successful Response + description: A PostTrainingJob. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/PostTrainingJob' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2906,68 +3925,18 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/supervised-fine-tune: - post: tags: - Post Training summary: Supervised Fine Tune + description: Run supervised fine-tuning of a model. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaPostTrainingSupervisedFineTunePostRequest' + required: true 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: Error: description: Error response from the API. Roughly follows RFC 7807. @@ -2993,63 +3962,61 @@ components: title: Error type: object ListBatchesResponse: - description: Response containing a list of batch objects. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: - description: List of batch objects items: $ref: '#/components/schemas/Batch' - title: Data type: array + title: Data + description: List of batch objects 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 + title: Has More + description: Whether there are more batches available + default: false + type: object required: - data title: ListBatchesResponse - type: object + description: Response containing a list of batch objects. Batch: - additionalProperties: true properties: id: + type: string title: Id - type: string completion_window: + type: string title: Completion Window - type: string created_at: - title: Created At type: integer + title: Created At endpoint: + type: string title: Endpoint - type: string input_file_id: - title: Input File Id type: string + title: Input File Id object: + type: string const: batch title: Object - type: string status: + type: string enum: - validating - failed @@ -3060,90 +4027,76 @@ components: - 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 + additionalProperties: true + type: object required: - id - completion_window @@ -3153,36 +4106,42 @@ components: - object - status title: Batch - type: object + Order: + type: string + enum: + - asc + - desc + title: Order + description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: - description: Response from listing OpenAI-compatible chat completions. properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse - type: object + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: @@ -3216,19 +4175,19 @@ components: title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionContentPartImageParam: - description: Image content part for OpenAI-compatible chat completion messages. properties: type: - const: image_url - default: image_url - title: Type type: string + const: image_url + title: Type + default: image_url image_url: $ref: '#/components/schemas/OpenAIImageURL' + type: object required: - image_url title: OpenAIChatCompletionContentPartImageParam - type: object + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -3245,139 +4204,130 @@ components: title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIChatCompletionContentPartTextParam: - description: Text content part for OpenAI-compatible chat completion messages. properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: OpenAIChatCompletionContentPartTextParam - type: object + description: Text content part for OpenAI-compatible chat completion messages. 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 + const: function + title: Type + default: function function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' - nullable: true title: OpenAIChatCompletionToolCallFunction - title: OpenAIChatCompletionToolCall type: object + title: OpenAIChatCompletionToolCall + description: Tool call specification for OpenAI-compatible chat completion responses. 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 + title: OpenAIChatCompletionToolCallFunction + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: - description: Usage information for OpenAI chat completion. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer completion_tokens: + type: integer title: Completion Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage - type: object + description: Usage information for OpenAI chat completion. 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + title: OpenAIUserMessageParam-Output | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' finish_reason: - title: Finish Reason type: string + title: Finish Reason index: - title: Index type: integer + title: Index logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' - nullable: true title: OpenAIChoiceLogprobs + type: object required: - message - finish_reason - index title: OpenAIChoice - type: object + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. properties: content: anyOf: @@ -3385,24 +4335,22 @@ components: $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 + title: OpenAIChoiceLogprobs + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: - description: A message from the developer in an OpenAI-compatible chat completion request. properties: role: - const: developer - default: developer - title: Role type: string + const: developer + title: Role + default: developer content: anyOf: - type: string @@ -3415,58 +4363,54 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAIDeveloperMessageParam - type: object + description: A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: properties: type: - const: file - default: file - title: Type type: string + const: file + title: Type + default: file file: $ref: '#/components/schemas/OpenAIFileFile' + type: object 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 + title: OpenAIFileFile OpenAIImageURL: - description: Image URL specification for OpenAI-compatible chat completion messages. properties: url: - title: Url type: string + title: Url detail: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - url title: OpenAIImageURL - type: object + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: discriminator: mapping: @@ -3489,13 +4433,12 @@ components: title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAISystemMessageParam: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string @@ -3508,12 +4451,36 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAISystemMessageParam - type: object + description: A system message providing instructions or context to the model. OpenAITokenLogProb: + properties: + token: + type: string + title: Token + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + logprob: + type: number + title: Logprob + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + type: array + title: Top Logprobs + type: object + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb description: |- The log probability for a token from an OpenAI-compatible chat completion response. @@ -3521,42 +4488,16 @@ components: :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 OpenAIToolMessageParam: - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. properties: role: + type: string const: tool - default: tool title: Role - type: string + default: tool tool_call_id: - title: Tool Call Id type: string + title: Tool Call Id content: anyOf: - type: string @@ -3565,37 +4506,37 @@ components: type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] + type: object required: - tool_call_id - content title: OpenAIToolMessageParam - type: object + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. 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 + title: Token bytes: anyOf: - items: type: integer type: array - type: 'null' - nullable: true logprob: - title: Logprob type: number + title: Logprob + type: object required: - token - logprob title: OpenAITopLogProb - type: object + 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 OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -3635,11 +4576,10 @@ components: title: OpenAIUserMessageParam type: object OpenAIJSONSchema: - description: JSON schema specification for OpenAI-compatible structured response format. properties: name: - title: Name type: string + title: Name description: anyOf: - type: string @@ -3653,32 +4593,33 @@ components: - additionalProperties: true type: object - type: 'null' + type: object title: OpenAIJSONSchema - type: object + description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: - description: JSON object response format for OpenAI-compatible chat completion requests. properties: type: + type: string const: json_object - default: json_object title: Type - type: string - title: OpenAIResponseFormatJSONObject + default: json_object type: object + title: OpenAIResponseFormatJSONObject + description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: - description: JSON schema response format for OpenAI-compatible chat completion requests. properties: type: - const: json_schema - default: json_schema - title: Type type: string + const: json_schema + title: Type + default: json_schema json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' + type: object required: - json_schema title: OpenAIResponseFormatJSONSchema - type: object + description: JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: discriminator: mapping: @@ -3695,52 +4636,49 @@ components: title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject OpenAIResponseFormatText: - description: Text response format for OpenAI-compatible chat completion requests. properties: type: - const: text - default: text - title: Type type: string - title: OpenAIResponseFormatText + const: text + title: Type + default: text type: object + title: OpenAIResponseFormatText + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible chat completion endpoint. properties: model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array minItems: 1 title: Messages - type: array frequency_penalty: anyOf: - type: number - type: 'null' - nullable: true function_call: anyOf: - type: string @@ -3748,7 +4686,6 @@ components: type: object - type: 'null' title: string | object - nullable: true functions: anyOf: - items: @@ -3756,68 +4693,58 @@ components: 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: + - oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject + discriminator: + propertyName: type + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format - nullable: true seed: anyOf: - type: integer - type: 'null' - nullable: true stop: anyOf: - type: string @@ -3827,23 +4754,19 @@ components: 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 @@ -3851,7 +4774,6 @@ components: type: object - type: 'null' title: string | object - nullable: true tools: anyOf: - items: @@ -3859,63 +4781,60 @@ components: 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 + additionalProperties: true + type: object required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: - description: Response from an OpenAI-compatible chat completion request. properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' - nullable: true title: OpenAIChatCompletionUsage + type: object required: - id - choices - created - model title: OpenAIChatCompletion - type: object + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: @@ -4011,55 +4930,55 @@ components: OpenAICompletionWithInputMessages: properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Input Messages + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output | ... (5 variants) type: array + title: Input Messages + type: object required: - id - choices @@ -4067,14 +4986,11 @@ components: - model - input_messages title: OpenAICompletionWithInputMessages - type: object OpenAICompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible completion endpoint. properties: model: - title: Model type: string + title: Model prompt: anyOf: - type: string @@ -4097,49 +5013,40 @@ components: 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 @@ -4149,44 +5056,66 @@ components: 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 + additionalProperties: true + type: object required: - model - prompt title: OpenAICompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: + properties: + id: + type: string + title: Id + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + type: array + title: Choices + created: + type: integer + title: Created + model: + type: string + title: Model + object: + type: string + const: text_completion + title: Object + default: text_completion + type: object + required: + - id + - choices + - created + - model + title: OpenAICompletion description: |- Response from an OpenAI-compatible completion request. @@ -4195,34 +5124,29 @@ components: :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 OpenAICompletionChoice: + properties: + finish_reason: + type: string + title: Finish Reason + text: + type: string + title: Text + index: + type: integer + title: Index + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + title: OpenAIChoiceLogprobs + type: object + required: + - finish_reason + - text + - index + title: OpenAICompletionChoice description: |- A choice from an OpenAI-compatible completion response. @@ -4230,29 +5154,6 @@ components: :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 ConversationItem: discriminator: mapping: @@ -4287,54 +5188,55 @@ components: title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) OpenAIResponseAnnotationCitation: - description: URL citation annotation for referencing external web resources. properties: type: + type: string const: url_citation - default: url_citation title: Type - type: string + default: url_citation end_index: + type: integer title: End Index - type: integer start_index: - title: Start Index type: integer + title: Start Index title: + type: string title: Title - type: string url: - title: Url type: string + title: Url + type: object required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation - type: object + description: URL citation annotation for referencing external web resources. OpenAIResponseAnnotationContainerFileCitation: properties: type: + type: string const: container_file_citation - default: container_file_citation title: Type - type: string + default: container_file_citation container_id: + type: string title: Container Id - type: string end_index: + type: integer title: End Index - type: integer file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename start_index: - title: Start Index type: integer + title: Start Index + type: object required: - container_id - end_index @@ -4342,48 +5244,47 @@ components: - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation - type: object OpenAIResponseAnnotationFileCitation: - description: File citation annotation for referencing specific files in response content. properties: type: + type: string const: file_citation - default: file_citation title: Type - type: string + default: file_citation file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename index: - title: Index type: integer + title: Index + type: object required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation - type: object + description: File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: properties: type: + type: string const: file_path - default: file_path title: Type - type: string + default: file_path file_id: - title: File Id type: string + title: File Id index: - title: Index type: integer + title: Index + type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath - type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -4403,49 +5304,47 @@ components: title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: - description: Refusal content within a streamed response part. properties: type: + type: string const: refusal - default: refusal title: Type - type: string + default: refusal refusal: - title: Refusal type: string + title: Refusal + type: object required: - refusal title: OpenAIResponseContentPartRefusal - type: object + description: Refusal content within a streamed response part. OpenAIResponseInputFunctionToolCallOutput: - description: This represents the output of a function call that gets passed back to the model. properties: call_id: + type: string title: Call Id - type: string output: + type: string title: Output - type: string type: - const: function_call_output - default: function_call_output - title: Type type: string + const: function_call_output + title: Type + default: function_call_output id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput - type: object + description: This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: discriminator: mapping: @@ -4462,134 +5361,126 @@ components: title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseInputMessageContentFile: - description: File content for input messages in OpenAI response format. properties: type: - const: input_file - default: input_file - title: Type type: string + const: input_file + title: Type + default: input_file 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 + title: OpenAIResponseInputMessageContentFile + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: - description: Image content for input messages in OpenAI response format. properties: detail: - default: auto title: Detail + default: auto type: string enum: - low - high - auto type: - const: input_image - default: input_image - title: Type type: string + const: input_image + title: Type + default: input_image file_id: anyOf: - type: string - type: 'null' - nullable: true image_url: anyOf: - type: string - type: 'null' - nullable: true - title: OpenAIResponseInputMessageContentImage type: object + title: OpenAIResponseInputMessageContentImage + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: - description: Text content for input messages in OpenAI response format. properties: text: + type: string title: Text - type: string type: - const: input_text - default: input_text - title: Type type: string + const: input_text + title: Type + default: input_text + type: object required: - text title: OpenAIResponseInputMessageContentText - type: object + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: - description: A request for human approval of a tool invocation. properties: arguments: + type: string title: Arguments - type: string id: + type: string title: Id - type: string name: + type: string title: Name - type: string server_label: + type: string title: Server Label - type: string type: - const: mcp_approval_request - default: mcp_approval_request - title: Type type: string + const: mcp_approval_request + title: Type + default: mcp_approval_request + type: object required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest - type: object + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: - description: A response to an MCP approval request. properties: approval_request_id: + type: string title: Approval Request Id - type: string approve: - title: Approve type: boolean + title: Approve type: - const: mcp_approval_response - default: mcp_approval_response - title: Type type: string + const: mcp_approval_response + title: Type + default: mcp_approval_response id: anyOf: - type: string - type: 'null' - nullable: true reason: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse - type: object + description: A response to an MCP approval request. OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -4676,22 +5567,15 @@ components: OpenAIResponseOutputMessageContentOutputText: properties: text: + type: string title: Text - type: string type: - const: output_text - default: output_text - title: Type type: string + const: output_text + title: Type + default: output_text 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 @@ -4701,176 +5585,177 @@ components: title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath + discriminator: + propertyName: type + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - title: Annotations type: array + title: Annotations + type: object required: - text title: OpenAIResponseOutputMessageContentOutputText - type: object OpenAIResponseOutputMessageFileSearchToolCall: - description: File search tool call output message for OpenAI responses. properties: id: - title: Id type: string + title: Id queries: items: type: string - title: Queries type: array + title: Queries status: + type: string title: Status - type: string type: - const: file_search_call - default: file_search_call - title: Type type: string + const: file_search_call + title: Type + default: file_search_call results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' - nullable: true + type: object required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall - type: object + description: File search tool call output message for OpenAI responses. OpenAIResponseOutputMessageFunctionToolCall: - description: Function tool call output message for OpenAI responses. properties: call_id: + type: string title: Call Id - type: string name: + type: string title: Name - type: string arguments: + type: string title: Arguments - type: string type: - const: function_call - default: function_call - title: Type type: string + const: function_call + title: Type + default: function_call id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall - type: object + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: - description: Model Context Protocol (MCP) call output message for OpenAI responses. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_call - default: mcp_call title: Type - type: string + default: mcp_call arguments: + type: string title: Arguments - type: string name: + type: string title: Name - type: string server_label: - title: Server Label type: string + title: Server Label error: anyOf: - type: string - type: 'null' - nullable: true output: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall - type: object + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: - description: MCP list tools output message containing available tools from an MCP server. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_list_tools - default: mcp_list_tools title: Type - type: string + default: mcp_list_tools server_label: - title: Server Label type: string + title: Server Label tools: items: $ref: '#/components/schemas/MCPListToolsTool' - title: Tools type: array + title: Tools + type: object required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools - type: object + description: MCP list tools output message containing available tools from an MCP server. OpenAIResponseOutputMessageWebSearchToolCall: - description: Web search tool call output message for OpenAI responses. properties: id: + type: string title: Id - type: string status: + type: string title: Status - type: string type: - const: web_search_call - default: web_search_call - title: Type type: string + const: web_search_call + title: Type + default: web_search_call + type: object required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall - type: object + description: Web search tool call output message for OpenAI responses. Conversation: - description: OpenAI-compatible conversation object. properties: id: - description: The unique ID of the conversation. + type: string title: Id - type: string + description: The unique ID of the conversation. object: - const: conversation - default: conversation - description: The object type, which is always conversation. - title: Object type: string + const: conversation + title: Object + description: The object type, which is always conversation. + default: conversation created_at: - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - title: Created At type: integer + title: Created At + description: The time at which the conversation was created, measured in seconds since the Unix epoch. metadata: anyOf: - additionalProperties: @@ -4878,7 +5763,6 @@ components: 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: @@ -4887,59 +5771,45 @@ components: 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 + type: object required: - id - created_at title: Conversation - type: object + description: OpenAI-compatible conversation object. ConversationDeletedResource: - description: Response for deleted conversation. properties: id: - description: The deleted conversation identifier + type: string title: Id - type: string + description: The deleted conversation identifier object: - default: conversation.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationDeletedResource - type: object + description: Response for deleted conversation. ConversationItemList: - description: List of conversation items with pagination. properties: object: - default: list - description: Object type - title: Object type: string + title: Object + description: Object type + default: list 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -4956,58 +5826,68 @@ components: title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - title: Data + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (9 variants) type: array + title: Data + description: List of conversation items 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 + title: Has More + description: Whether there are more items available + default: false + type: object required: - data title: ConversationItemList - type: object + description: List of conversation items with pagination. ConversationItemDeletedResource: - description: Response for deleted conversation item. properties: id: - description: The deleted item identifier + type: string title: Id - type: string + description: The deleted item identifier object: - default: conversation.item.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.item.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationItemDeletedResource - type: object + description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible embeddings endpoint. properties: model: - title: Model type: string + title: Model input: anyOf: - type: string @@ -5025,25 +5905,24 @@ components: anyOf: - type: integer - type: 'null' - nullable: true user: anyOf: - type: string - type: 'null' - nullable: true + additionalProperties: true + type: object required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: - description: A single embedding data object from an OpenAI-compatible embeddings response. properties: object: - const: embedding - default: embedding - title: Object type: string + const: embedding + title: Object + default: embedding embedding: anyOf: - items: @@ -5053,112 +5932,113 @@ components: - type: string title: list[number] | string index: - title: Index type: integer + title: Index + type: object required: - embedding - index title: OpenAIEmbeddingData - type: object + description: A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: - description: Usage information for an OpenAI-compatible embeddings response. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens + type: object required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage - type: object + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: - description: Response from an OpenAI-compatible embeddings request. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' - title: Data type: array + title: Data model: - title: Model type: string + title: Model usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' + type: object required: - data - model - usage title: OpenAIEmbeddingsResponse - type: object + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: - description: Valid purpose values for OpenAI Files API. + type: string enum: - assistants - batch title: OpenAIFilePurpose - type: string + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: - description: Response for listing files in OpenAI Files API. properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse - type: object + description: Response for listing files in OpenAI Files API. OpenAIFileObject: - description: OpenAI File object as defined in the OpenAI Files API. properties: object: + type: string const: file - default: file title: Object - type: string + default: file id: + type: string title: Id - type: string bytes: + type: integer title: Bytes - type: integer created_at: + type: integer title: Created At - type: integer expires_at: - title: Expires At type: integer + title: Expires At filename: - title: Filename type: string + title: Filename purpose: $ref: '#/components/schemas/OpenAIFilePurpose' + type: object required: - id - bytes @@ -5167,90 +6047,119 @@ components: - filename - purpose title: OpenAIFileObject - type: object + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: + properties: + anchor: + type: string + const: created_at + title: Anchor + seconds: + type: integer + maximum: 2592000.0 + minimum: 3600.0 + title: Seconds + type: object + required: + - anchor + - seconds + title: 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 OpenAIFileDeleteResponse: - description: Response for deleting a file in OpenAI Files API. properties: id: + type: string title: Id - type: string object: - const: file - default: file - title: Object type: string + const: file + title: Object + default: file deleted: - title: Deleted type: boolean + title: Deleted + type: object required: - id - deleted title: OpenAIFileDeleteResponse + description: Response for deleting a file in OpenAI Files API. + Response: + title: Response type: object HealthInfo: - description: Health status information for the service. properties: status: $ref: '#/components/schemas/HealthStatus' + type: object required: - status title: HealthInfo - type: object + description: Health status information for the service. RouteInfo: - description: Information about an API route including its path, method, and implementing providers. properties: route: + type: string title: Route - type: string method: - title: Method type: string + title: Method provider_types: items: type: string - title: Provider Types type: array + title: Provider Types + type: object required: - route - method - provider_types title: RouteInfo - type: object + description: Information about an API route including its path, method, and implementing providers. ListRoutesResponse: - description: Response containing a list of all available API routes. properties: data: items: $ref: '#/components/schemas/RouteInfo' - title: Data type: array + title: Data + type: object required: - data title: ListRoutesResponse - type: object + description: Response containing a list of all available API routes. OpenAIModel: + properties: + id: + type: string + title: Id + object: + type: string + const: model + title: Object + default: model + created: + type: integer + title: Created + owned_by: + type: string + title: Owned By + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - id + - created + - owned_by + title: OpenAIModel description: |- A model from OpenAI. @@ -5259,120 +6168,90 @@ components: :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 + title: Data + type: object required: - data title: OpenAIListModelsResponse - type: object 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: model - default: model - title: Type type: string + const: model + title: Type + default: model metadata: additionalProperties: true - description: Any additional metadata for this model - title: Metadata type: object + title: Metadata + description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm + type: object required: - identifier - provider_id title: Model - type: object + description: A model resource representing an AI model registered in Llama Stack. ModelType: - description: Enumeration of supported model types in Llama Stack. + type: string enum: - llm - embedding - rerank title: ModelType - type: string + description: Enumeration of supported model types in Llama Stack. ModerationObject: - description: A moderation object. properties: id: + type: string title: Id - type: string model: - title: Model type: string + title: Model results: items: $ref: '#/components/schemas/ModerationObjectResults' - title: Results type: array + title: Results + type: object required: - id - model - results title: ModerationObject - type: object - ModerationObjectResults: description: A moderation object. + ModerationObjectResults: properties: flagged: - title: Flagged type: boolean + title: Flagged categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' - nullable: true category_applied_input_types: anyOf: - additionalProperties: @@ -5381,93 +6260,90 @@ components: 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 + title: Metadata + type: object required: - flagged title: ModerationObjectResults - type: object + description: A moderation 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 + minimum: 1.0 + title: Version + description: Version (integer starting at 1, incremented on save) prompt_id: - description: Unique identifier in format 'pmpt_<48-digit-hash>' - title: Prompt Id type: string + title: Prompt Id + description: Unique identifier in format 'pmpt_<48-digit-hash>' variables: - description: List of variable names that can be used in the prompt template items: type: string - title: Variables type: array + title: Variables + description: List of variable names that can be used in the prompt template is_default: - default: false - description: Boolean indicating whether this version is the default version - title: Is Default type: boolean + title: Is Default + description: Boolean indicating whether this version is the default version + default: false + type: object required: - version - prompt_id title: Prompt - type: object + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. ListPromptsResponse: - description: Response model to list prompts. properties: data: items: $ref: '#/components/schemas/Prompt' - title: Data type: array + title: Data + type: object required: - data title: ListPromptsResponse - type: object + description: Response model to list prompts. ProviderInfo: - description: Information about a registered provider including its configuration and health status. properties: api: + type: string title: Api - type: string provider_id: + type: string title: Provider Id - type: string provider_type: - title: Provider Type type: string + title: Provider Type config: additionalProperties: true - title: Config type: object + title: Config health: additionalProperties: true - title: Health type: object + title: Health + type: object required: - api - provider_id @@ -5475,62 +6351,62 @@ components: - config - health title: ProviderInfo - type: object + description: Information about a registered provider including its configuration and health status. ListProvidersResponse: - description: Response containing a list of all available providers. properties: data: items: $ref: '#/components/schemas/ProviderInfo' - title: Data type: array + title: Data + type: object required: - data title: ListProvidersResponse - type: object + description: Response containing a list of all available providers. ListOpenAIResponseObject: - description: Paginated list of OpenAI response objects with navigation metadata. properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject - type: object + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: - description: Error details for failed OpenAI response requests. properties: code: + type: string title: Code - type: string message: - title: Message type: string + title: Message + type: object required: - code - message title: OpenAIResponseError - type: object + description: Error details for failed OpenAI response requests. OpenAIResponseInput: anyOf: - discriminator: @@ -5567,29 +6443,27 @@ components: title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage OpenAIResponseInputToolFileSearch: - description: File search tool configuration for OpenAI response inputs. properties: type: - const: file_search - default: file_search - title: Type type: string + const: file_search + title: Type + default: file_search vector_store_ids: items: type: string - title: Vector Store Ids type: array + title: Vector Store Ids filters: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true max_num_results: anyOf: - - maximum: 50 - minimum: 1 - type: integer + - type: integer + maximum: 50.0 + minimum: 1.0 - type: 'null' default: 10 ranking_options: @@ -5597,28 +6471,26 @@ components: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' - nullable: true title: SearchRankingOptions + type: object required: - vector_store_ids title: OpenAIResponseInputToolFileSearch - type: object + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: - description: Function tool configuration for OpenAI response inputs. properties: type: + type: string const: function - default: function title: Type - type: string + default: function name: - title: Name type: string + title: Name description: anyOf: - type: string - type: 'null' - nullable: true parameters: anyOf: - additionalProperties: true @@ -5628,18 +6500,17 @@ components: anyOf: - type: boolean - type: 'null' - nullable: true + type: object required: - name - parameters title: OpenAIResponseInputToolFunction - type: object + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: - description: Web search tool configuration for OpenAI response inputs. properties: type: - default: web_search title: Type + default: web_search type: string enum: - web_search @@ -5648,51 +6519,40 @@ components: - web_search_2025_08_26 search_context_size: anyOf: - - pattern: ^low|medium|high$ - type: string + - type: string + pattern: ^low|medium|high$ - type: 'null' default: medium - title: OpenAIResponseInputToolWebSearch type: object + title: OpenAIResponseInputToolWebSearch + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: - description: OpenAI response object extended with input context information. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5705,33 +6565,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -5741,20 +6608,9 @@ components: 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 @@ -5764,48 +6620,43 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5818,16 +6669,27 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Input + type: object required: - created_at - id @@ -5836,7 +6698,7 @@ components: - status - input title: OpenAIResponseObjectWithInput - type: object + description: OpenAI response object extended with input context information. OpenAIResponseOutput: discriminator: mapping: @@ -5865,20 +6727,13 @@ components: title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) OpenAIResponsePrompt: - description: OpenAI compatible Prompt object that is used in OpenAI responses. properties: id: - title: Id type: string + title: Id 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 @@ -5886,31 +6741,35 @@ components: title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' - nullable: true version: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id title: OpenAIResponsePrompt - type: object + description: OpenAI compatible Prompt object that is used in OpenAI responses. 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 + title: OpenAIResponseText + description: Text response configuration for OpenAI responses. OpenAIResponseTool: discriminator: mapping: @@ -5933,16 +6792,15 @@ components: title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: - title: Server Label type: string + title: Server Label allowed_tools: anyOf: - items: @@ -5953,43 +6811,41 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label title: OpenAIResponseToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. OpenAIResponseUsage: - description: Usage information for OpenAI response. properties: input_tokens: + type: integer title: Input Tokens - type: integer output_tokens: + type: integer title: Output Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - input_tokens - output_tokens - total_tokens title: OpenAIResponseUsage - type: object + description: Usage information for OpenAI response. ResponseGuardrailSpec: description: Specification for a guardrail to apply during response generation. properties: @@ -6022,40 +6878,37 @@ components: title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseInputToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: + type: string title: Server Label - type: string server_url: - title: Server Url type: string + title: Server Url 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 + - type: string + const: always + - type: string + const: never - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter - default: never title: string | ApprovalFilter + default: never allowed_tools: anyOf: - items: @@ -6066,51 +6919,39 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label - server_url title: OpenAIResponseInputToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseObject: - description: Complete OpenAI response object containing generation results and metadata. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -6123,33 +6964,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -6159,20 +7007,9 @@ components: 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 @@ -6182,32 +7019,38 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + type: object required: - created_at - id @@ -6215,7 +7058,7 @@ components: - output - status title: OpenAIResponseObject - type: object + description: Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: @@ -7379,43 +8222,32 @@ components: title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: - description: Response object confirming deletion of an OpenAI response. properties: id: + type: string title: Id - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: OpenAIDeleteResponseObject - type: object + description: Response object confirming deletion of an OpenAI response. 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -7428,39 +8260,48 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Data object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data title: ListOpenAIResponseInputItem - type: object + description: List container for OpenAI response input items. 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 + title: RunShieldResponse + description: Response from running a safety shield. SafetyViolation: - description: Details of a safety violation detected by content moderation. properties: violation_level: $ref: '#/components/schemas/ViolationLevel' @@ -7468,25 +8309,25 @@ components: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - title: Metadata type: object + title: Metadata + type: object required: - violation_level title: SafetyViolation - type: object + description: Details of a safety violation detected by content moderation. ViolationLevel: - description: Severity level of a safety violation. + type: string enum: - info - warn - error title: ViolationLevel - type: string + description: Severity level of a safety violation. AggregationFunctionType: - description: Types of aggregation functions for scoring results. + type: string enum: - average - weighted_average @@ -7494,193 +8335,176 @@ components: - categorical_count - accuracy title: AggregationFunctionType - type: string + description: Types of aggregation functions for scoring results. ArrayType: - description: Parameter type for array values. properties: type: + type: string const: array - default: array title: Type - type: string - title: ArrayType + default: array type: object + title: ArrayType + description: Parameter type for array values. BasicScoringFnParams: - description: Parameters for basic scoring function configuration. properties: type: - const: basic - default: basic - title: Type type: string + const: basic + title: Type + default: basic aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object title: BasicScoringFnParams - type: object + description: Parameters for basic scoring function configuration. BooleanType: - description: Parameter type for boolean values. properties: type: + type: string const: boolean + title: Type default: boolean - title: Type - type: string + type: object title: BooleanType - type: object + description: Parameter type for boolean values. ChatCompletionInputType: - description: Parameter type for chat completion input. properties: type: + type: string const: chat_completion_input + title: Type default: chat_completion_input - title: Type - type: string + type: object title: ChatCompletionInputType - type: object + description: Parameter type for chat completion input. CompletionInputType: - description: Parameter type for completion input. properties: type: + type: string const: completion_input + title: Type default: completion_input - title: Type - type: string + type: object title: CompletionInputType - type: object + description: Parameter type for completion input. JsonType: - description: Parameter type for JSON values. properties: type: + type: string const: json - default: json title: Type - type: string - title: JsonType + default: json type: object + title: JsonType + description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: - description: Parameters for LLM-as-judge scoring function configuration. properties: type: + type: string const: llm_as_judge - default: llm_as_judge title: Type - type: string + default: llm_as_judge judge_model: - title: Judge Model type: string + title: Judge Model 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 + title: Judge Score Regexes + description: Regexes to extract the answer from generated response aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object required: - judge_model title: LLMAsJudgeScoringFnParams - type: object + description: Parameters for LLM-as-judge scoring function configuration. NumberType: - description: Parameter type for numeric values. properties: type: + type: string const: number + title: Type default: number - title: Type - type: string + type: object title: NumberType - type: object + description: Parameter type for numeric values. ObjectType: - description: Parameter type for object values. properties: type: + type: string const: object - default: object title: Type - type: string - title: ObjectType + default: object type: object + title: ObjectType + description: Parameter type for object values. RegexParserScoringFnParams: - description: Parameters for regex parser scoring function configuration. properties: type: - const: regex_parser - default: regex_parser - title: Type type: string + const: regex_parser + title: Type + default: regex_parser parsing_regexes: - description: Regex to extract the answer from generated response items: type: string - title: Parsing Regexes type: array + title: Parsing Regexes + description: Regex to extract the answer from generated response 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 + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row type: object + title: RegexParserScoringFnParams + description: Parameters for regex parser scoring function configuration. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: scoring_function - default: scoring_function - title: Type type: string + const: scoring_function + title: Type + default: scoring_function description: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - description: Any additional metadata for this definition - title: Metadata type: object + title: Metadata + description: Any additional metadata for this definition 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 @@ -7701,32 +8525,45 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + description: The return type of the deterministic function + discriminator: + propertyName: type + 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' params: anyOf: - - discriminator: - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - propertyName: type - oneOf: + - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + type: object required: - identifier - provider_id - return_type title: ScoringFn - type: object + description: A scoring function resource for evaluating model outputs. ScoringFnParams: discriminator: mapping: @@ -7743,127 +8580,124 @@ components: title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams StringType: - description: Parameter type for string values. properties: type: + type: string const: string - default: string title: Type - type: string - title: StringType + default: string type: object + title: StringType + description: Parameter type for string values. UnionType: - description: Parameter type for union values. properties: type: - const: union - default: union - title: Type type: string - title: UnionType + const: union + title: Type + default: union type: object + title: UnionType + description: Parameter type for union values. ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' - title: Data type: array + title: Data + type: object required: - data title: ListScoringFunctionsResponse - type: object ScoreResponse: - description: The response from scoring. properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Results type: object + title: Results + type: object required: - results title: ScoreResponse - type: object + description: The response from scoring. ScoringResult: - description: A scoring result for a single row. properties: score_rows: items: additionalProperties: true type: object - title: Score Rows type: array + title: Score Rows aggregated_results: additionalProperties: true - title: Aggregated Results type: object + title: Aggregated Results + type: object required: - score_rows - aggregated_results title: ScoringResult - type: object + description: A scoring result for a single row. 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 + title: Results + type: object required: - results title: ScoreBatchResponse - type: object + description: Response from batch scoring operations on datasets. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: shield - default: shield - title: Type type: string + const: shield + title: Type + default: shield params: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true + type: object required: - identifier - provider_id title: Shield - type: object + description: A safety shield resource that can be used to check content. ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' - title: Data type: array + title: Data + type: object required: - data title: ListShieldsResponse - type: object ImageContentItem: description: A image content item properties: @@ -7920,184 +8754,172 @@ components: title: TextContentItem title: ImageContentItem | TextContentItem TextContentItem: - description: A text content item properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: TextContentItem - type: object + description: A text content item 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 + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Output | TextContentItem] - type: 'null' - title: string | list[ImageContentItem | TextContentItem] - nullable: true + title: string | list[ImageContentItem-Output | TextContentItem] 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 + title: ToolInvocationResult + description: Result of a tool invocation. URL: - description: A URL reference to external content. properties: uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URL - type: object + description: A URL reference to external content. ToolDef: - description: Tool definition used in runtime contexts. properties: toolgroup_id: anyOf: - type: string - type: 'null' - nullable: true name: - title: Name type: string + title: Name 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 + type: object required: - name title: ToolDef - type: object + description: Tool definition used in runtime contexts. ListToolDefsResponse: - description: Response containing a list of tool definitions. properties: data: items: $ref: '#/components/schemas/ToolDef' - title: Data type: array + title: Data + type: object required: - data title: ListToolDefsResponse - type: object + description: Response containing a list of tool definitions. ToolGroup: - description: A group of related tools managed together. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: tool_group - default: tool_group - title: Type type: string + const: tool_group + title: Type + default: tool_group 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 + type: object required: - identifier - provider_id title: ToolGroup - type: object + description: A group of related tools managed together. ListToolGroupsResponse: - description: Response containing a list of tool groups. properties: data: items: $ref: '#/components/schemas/ToolGroup' - title: Data type: array + title: Data + type: object required: - data title: ListToolGroupsResponse - type: object + description: Response containing a list of tool groups. Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -8157,105 +8979,94 @@ components: title: Chunk 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 + title: 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. QueryChunksResponse: - description: Response from querying chunks in a vector database. properties: chunks: items: - $ref: '#/components/schemas/Chunk' - title: Chunks + $ref: '#/components/schemas/Chunk-Output' type: array + title: Chunks scores: items: type: number - title: Scores type: array + title: Scores + type: object required: - chunks - scores title: QueryChunksResponse - type: object + description: Response from querying chunks in a vector database. VectorStoreFileCounts: - description: File processing status counts for a vector store. properties: completed: + type: integer title: Completed - type: integer cancelled: + type: integer title: Cancelled - type: integer failed: + type: integer title: Failed - type: integer in_progress: + type: integer title: In Progress - type: integer total: - title: Total type: integer + title: Total + type: object required: - completed - cancelled @@ -8263,91 +9074,85 @@ components: - in_progress - total title: VectorStoreFileCounts - type: object + description: File processing status counts for a vector store. VectorStoreListResponse: - description: Response from listing vector stores. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListResponse - type: object + description: Response from listing vector stores. VectorStoreObject: - description: OpenAI Vector Store object. properties: id: + type: string title: Id - type: string object: - default: vector_store - title: Object type: string + title: Object + default: vector_store created_at: - title: Created At type: integer + title: Created At name: anyOf: - type: string - type: 'null' - nullable: true usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: - default: completed - title: Status type: string + title: Status + default: completed 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 + title: Metadata + type: object required: - id - created_at - file_counts title: VectorStoreObject - type: object + description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: @@ -8361,159 +9166,151 @@ components: title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreChunkingStrategyAuto: - description: Automatic chunking strategy for vector store files. properties: type: + type: string const: auto - default: auto title: Type - type: string - title: VectorStoreChunkingStrategyAuto + default: auto type: object + title: VectorStoreChunkingStrategyAuto + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: - description: Static chunking strategy with configurable parameters. properties: type: - const: static - default: static - title: Type type: string + const: static + title: Type + default: static static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + type: object required: - static title: VectorStoreChunkingStrategyStatic - type: object + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: - description: Configuration for static chunking strategy. properties: chunk_overlap_tokens: - default: 400 + type: integer title: Chunk Overlap Tokens - type: integer + default: 400 max_chunk_size_tokens: - default: 800 - maximum: 4096 - minimum: 100 - title: Max Chunk Size Tokens type: integer - title: VectorStoreChunkingStrategyStaticConfig + maximum: 4096.0 + minimum: 100.0 + title: Max Chunk Size Tokens + default: 800 type: object + title: VectorStoreChunkingStrategyStaticConfig + description: Configuration for static chunking strategy. 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true - title: OpenAICreateVectorStoreRequestWithExtraBody + additionalProperties: true type: object + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. VectorStoreDeleteResponse: - description: Response from deleting a vector store. properties: id: + type: string title: Id - type: string object: - default: vector_store.deleted - title: Object type: string + title: Object + default: vector_store.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreDeleteResponse - type: object + description: Response from deleting a vector store. 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 + title: File Ids 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true + additionalProperties: true + type: object required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - type: object + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: - description: OpenAI Vector Store File Batch object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file_batch + type: string title: Object - type: string + default: vector_store.file_batch created_at: - title: Created At type: integer + title: Created At vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id status: title: Status type: string @@ -8525,6 +9322,7 @@ components: default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' + type: object required: - id - created_at @@ -8532,7 +9330,7 @@ components: - status - file_counts title: VectorStoreFileBatchObject - type: object + description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: type: string enum: @@ -8542,7 +9340,6 @@ components: - failed default: completed VectorStoreFileLastError: - description: Error information for failed vector store file processing. properties: code: title: Code @@ -8552,48 +9349,47 @@ components: - rate_limit_exceeded default: server_error message: - title: Message type: string + title: Message + type: object required: - code - message title: VectorStoreFileLastError - type: object + description: Error information for failed vector store file processing. VectorStoreFileObject: - description: OpenAI Vector Store File object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file - title: Object type: string + title: Object + default: vector_store.file attributes: additionalProperties: true - title: Attributes type: object + title: Attributes 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 + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' created_at: - title: Created At type: integer + title: Created At last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' - nullable: true title: VectorStoreFileLastError status: title: Status @@ -8605,12 +9401,13 @@ components: - failed default: completed usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id + type: object required: - id - chunking_strategy @@ -8618,158 +9415,149 @@ components: - status - vector_store_id title: VectorStoreFileObject - type: object + description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: - description: Response from listing files in a vector store file batch. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreFilesListInBatchResponse - type: object + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: - description: Response from listing files in a vector store. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListFilesResponse - type: object + description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: - description: Response from deleting a vector store file. properties: id: + type: string title: Id - type: string object: - default: vector_store.file.deleted - title: Object type: string + title: Object + default: vector_store.file.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreFileDeleteResponse - type: object + description: Response from deleting a vector store file. VectorStoreContent: - description: Content item from a vector store file or search result. properties: type: + type: string const: text title: Type - type: string text: - title: Text type: string + title: Text 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 + type: object required: - type - text title: VectorStoreContent - type: object + description: Content item from a vector store file or search result. 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 + const: vector_store.file_content.page + title: Object + default: vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data title: VectorStoreFileContentResponse - type: object + description: Represents the parsed content of a vector store file. VectorStoreSearchResponse: - description: Response from searching a vector store. properties: file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename score: - title: Score type: number + title: Score attributes: anyOf: - additionalProperties: @@ -8780,241 +9568,230 @@ components: title: string | number | boolean type: object - type: 'null' - nullable: true content: items: $ref: '#/components/schemas/VectorStoreContent' - title: Content type: array + title: Content + type: object required: - file_id - filename - score - content title: VectorStoreSearchResponse - type: object + description: Response from searching a vector store. VectorStoreSearchResponsePage: - description: Paginated response from searching a vector store. properties: object: - default: vector_store.search_results.page - title: Object type: string + title: Object + default: vector_store.search_results.page search_query: items: type: string - title: Search Query type: array + title: Search Query data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - search_query - data title: VectorStoreSearchResponsePage - type: object + description: Paginated response from searching a vector store. VersionInfo: - description: Version information for the service. properties: version: - title: Version type: string + title: Version + type: object required: - version title: VersionInfo - type: object + description: Version information for the service. PaginatedResponse: - description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More url: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data - has_more title: PaginatedResponse - type: object + description: A generic paginated response that follows a simple format. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: dataset - default: dataset - title: Type type: string + const: dataset + title: Type + default: dataset 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 + discriminator: + propertyName: type + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' metadata: additionalProperties: true - description: Any additional metadata for this dataset - title: Metadata type: object + title: Metadata + description: Any additional metadata for this dataset + type: object required: - identifier - provider_id - purpose - source title: Dataset - type: object + description: Dataset resource for storing and accessing training or evaluation data. RowsDataSource: - description: A dataset stored in rows. properties: type: - const: rows - default: rows - title: Type type: string + const: rows + title: Type + default: rows rows: items: additionalProperties: true type: object - title: Rows type: array + title: Rows + type: object required: - rows title: RowsDataSource - type: object + description: A dataset stored in rows. URIDataSource: - description: A dataset that can be obtained from a URI. properties: type: + type: string const: uri - default: uri title: Type - type: string + default: uri uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URIDataSource - type: object + description: A dataset that can be obtained from a URI. ListDatasetsResponse: - description: Response from listing datasets. properties: data: items: $ref: '#/components/schemas/Dataset' - title: Data type: array + title: Data + type: object required: - data title: ListDatasetsResponse - type: object + description: Response from listing datasets. Benchmark: - description: A benchmark resource for evaluating model performance. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: + type: string const: benchmark - default: benchmark title: Type - type: string + default: benchmark dataset_id: - title: Dataset Id type: string + title: Dataset Id scoring_functions: items: type: string - title: Scoring Functions type: array + title: Scoring Functions metadata: additionalProperties: true - description: Metadata for this evaluation task - title: Metadata type: object + title: Metadata + description: Metadata for this evaluation task + type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark - type: object + description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' - title: Data type: array + title: Data + type: object required: - data title: ListBenchmarksResponse - 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 @@ -9022,41 +9799,46 @@ components: title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + title: Scoring Params + description: Map between scoring function id and parameters for each scoring function you want to run 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 + type: object required: - eval_candidate title: BenchmarkConfig - type: object + description: A benchmark configuration for evaluation. GreedySamplingStrategy: - description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: + type: string const: greedy - default: greedy title: Type - type: string - title: GreedySamplingStrategy + default: greedy type: object + title: GreedySamplingStrategy + description: Greedy sampling strategy that selects the highest probability token at each step. ModelCandidate: - description: A model candidate for evaluation. properties: type: + type: string const: model - default: model title: Type - type: string + default: model model: - title: Model type: string + title: Model sampling_params: $ref: '#/components/schemas/SamplingParams' system_message: @@ -9064,23 +9846,16 @@ components: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' - nullable: true title: SystemMessage + type: object required: - model - sampling_params title: ModelCandidate - type: object + description: A model candidate for evaluation. 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 @@ -9089,11 +9864,16 @@ components: - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + discriminator: + propertyName: type + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' max_tokens: anyOf: - type: integer - type: 'null' - nullable: true repetition_penalty: anyOf: - type: number @@ -9105,74 +9885,73 @@ components: type: string type: array - type: 'null' - nullable: true - title: SamplingParams type: object + title: SamplingParams + description: Sampling parameters. SystemMessage: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string - - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type - oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] - title: string | list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + type: object required: - content title: SystemMessage - type: object + description: A system message providing instructions or context to the model. 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 + const: top_k + title: Type + default: top_k top_k: - minimum: 1 - title: Top K type: integer + minimum: 1.0 + title: Top K + type: object required: - top_k title: TopKSamplingStrategy - type: object + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. 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 + const: top_p + title: Type + default: top_p temperature: anyOf: - type: number @@ -9183,94 +9962,94 @@ components: - type: number - type: 'null' default: 0.95 + type: object required: - temperature title: TopPSamplingStrategy - type: object + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. EvaluateResponse: - description: The response from an evaluation. properties: generations: items: additionalProperties: true type: object - title: Generations type: array + title: Generations scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Scores type: object + title: Scores + type: object required: - generations - scores title: EvaluateResponse - type: object + description: The response from an evaluation. Job: - description: A job execution instance with status tracking. properties: job_id: - title: Job Id type: string + title: Job Id status: $ref: '#/components/schemas/JobStatus' + type: object required: - job_id - status title: Job - type: object + description: A job execution instance with status tracking. RerankData: - description: A single rerank result from a reranking response. properties: index: - title: Index type: integer + title: Index relevance_score: - title: Relevance Score type: number + title: Relevance Score + type: object required: - index - relevance_score title: RerankData - type: object + description: A single rerank result from a reranking response. RerankResponse: - description: Response from a reranking request. properties: data: items: $ref: '#/components/schemas/RerankData' - title: Data type: array + title: Data + type: object required: - data title: RerankResponse - type: object + description: Response from a reranking request. Checkpoint: - description: Checkpoint created during training runs. properties: identifier: - title: Identifier type: string + title: Identifier created_at: + type: string format: date-time title: Created At - type: string epoch: - title: Epoch type: integer + title: Epoch post_training_job_id: + type: string title: Post Training Job Id - type: string path: - title: Path type: string + title: Path training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' - nullable: true title: PostTrainingMetric + type: object required: - identifier - created_at @@ -9278,137 +10057,131 @@ components: - post_training_job_id - path title: Checkpoint - type: object + description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: - description: Artifacts of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid checkpoints: items: $ref: '#/components/schemas/Checkpoint' - title: Checkpoints type: array + title: Checkpoints + type: object required: - job_uuid title: PostTrainingJobArtifactsResponse - type: object + description: Artifacts of a finetuning job. PostTrainingMetric: - description: Training metrics captured during post-training jobs. properties: epoch: - title: Epoch type: integer + title: Epoch train_loss: + type: number title: Train Loss - type: number validation_loss: + type: number title: Validation Loss - type: number perplexity: - title: Perplexity type: number + title: Perplexity + type: object required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric - type: object + description: Training metrics captured during post-training jobs. PostTrainingJobStatusResponse: - description: Status of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true started_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true completed_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - 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 + title: Checkpoints + type: object required: - job_uuid - status title: PostTrainingJobStatusResponse - type: object + description: Status of a finetuning job. ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' - title: Data type: array + title: Data + type: object required: - data title: ListPostTrainingJobsResponse - type: object DPOAlignmentConfig: - description: Configuration for Direct Preference Optimization (DPO) alignment. properties: beta: - title: Beta type: number + title: Beta loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid + type: object required: - beta title: DPOAlignmentConfig - type: object + description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: + type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType - type: string DataConfig: - description: Configuration for training data and data loading. properties: dataset_id: - title: Dataset Id type: string + title: Dataset Id batch_size: - title: Batch Size type: integer + title: Batch Size shuffle: - title: Shuffle type: boolean + title: Shuffle data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' - nullable: true packed: anyOf: - type: boolean @@ -9419,22 +10192,22 @@ components: - type: boolean - type: 'null' default: false + type: object required: - dataset_id - batch_size - shuffle - data_format title: DataConfig - type: object + description: Configuration for training data and data loading. DatasetFormat: - description: Format of the training dataset. + type: string enum: - instruct - dialog title: DatasetFormat - type: string + description: Format of the training dataset. EfficiencyConfig: - description: Configuration for memory and compute efficiency optimizations. properties: enable_activation_checkpointing: anyOf: @@ -9456,51 +10229,51 @@ components: - type: boolean - type: 'null' default: false - title: EfficiencyConfig type: object + title: EfficiencyConfig + description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: - description: Configuration parameters for the optimization algorithm. properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: + type: number title: Lr - type: number weight_decay: - title: Weight Decay type: number + title: Weight Decay num_warmup_steps: - title: Num Warmup Steps type: integer + title: Num Warmup Steps + type: object required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig - type: object + description: Configuration parameters for the optimization algorithm. OptimizerType: - description: Available optimizer algorithms for training. + type: string enum: - adam - adamw - sgd title: OptimizerType - type: string + description: Available optimizer algorithms for training. TrainingConfig: - description: Comprehensive configuration for the training process. properties: n_epochs: + type: integer title: N Epochs - type: integer max_steps_per_epoch: - default: 1 + type: integer title: Max Steps Per Epoch - type: integer - gradient_accumulation_steps: default: 1 - title: Gradient Accumulation Steps + gradient_accumulation_steps: type: integer + title: Gradient Accumulation Steps + default: 1 max_validation_steps: anyOf: - type: integer @@ -9511,40 +10284,38 @@ components: - $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 + type: object required: - n_epochs title: TrainingConfig - type: object + description: Comprehensive configuration for the training process. PostTrainingJob: properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid + type: object required: - job_uuid title: PostTrainingJob - type: object AlgorithmConfig: discriminator: mapping: @@ -9558,30 +10329,29 @@ components: title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig LoraFinetuningConfig: - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. properties: type: - const: LoRA - default: LoRA - title: Type type: string + const: LoRA + title: Type + default: LoRA lora_attn_modules: items: type: string - title: Lora Attn Modules type: array + title: Lora Attn Modules apply_lora_to_mlp: + type: boolean title: Apply Lora To Mlp - type: boolean apply_lora_to_output: - title: Apply Lora To Output type: boolean + title: Apply Lora To Output rank: + type: integer title: Rank - type: integer alpha: - title: Alpha type: integer + title: Alpha use_dora: anyOf: - type: boolean @@ -9592,6 +10362,7 @@ components: - type: boolean - type: 'null' default: false + type: object required: - lora_attn_modules - apply_lora_to_mlp @@ -9599,26 +10370,26 @@ components: - rank - alpha title: LoraFinetuningConfig - type: object + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. properties: type: + type: string const: QAT - default: QAT title: Type - type: string + default: QAT quantizer_name: - title: Quantizer Name type: string + title: Quantizer Name group_size: - title: Group Size type: integer + title: Group Size + type: object required: - quantizer_name - group_size title: QATFinetuningConfig - type: object + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. ParamType: discriminator: mapping: @@ -9664,24 +10435,1600 @@ components: - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource + AllowedToolsFilter: + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can be used. + ApprovalFilter: + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. + BatchError: + properties: + code: + anyOf: + - type: string + - type: 'null' + line: + anyOf: + - type: integer + - type: 'null' + message: + anyOf: + - type: string + - type: 'null' + param: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: BatchError + BatchRequestCounts: + properties: + completed: + type: integer + title: Completed + failed: + type: integer + title: Failed + total: + type: integer + title: Total + additionalProperties: true + type: object + required: + - completed + - failed + - total + title: BatchRequestCounts + BatchUsage: + properties: + input_tokens: + type: integer + title: Input Tokens + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + type: integer + title: Output Tokens + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + type: integer + title: Total Tokens + additionalProperties: true + type: object + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + BatchesPostRequest: + properties: + input_file_id: + type: string + title: Input File Id + endpoint: + type: string + title: Endpoint + completion_window: + type: string + const: 24h + title: Completion Window + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + idempotency_key: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_file_id + - endpoint + - completion_window + title: BatchesPostRequest + Body_openai_upload_file_v1_files_post: + properties: + file: + type: string + format: binary + title: File + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + expires_after: + anyOf: + - $ref: '#/components/schemas/ExpiresAfter' + title: ExpiresAfter + - type: 'null' + title: ExpiresAfter + type: object + required: + - file + - purpose + title: Body_openai_upload_file_v1_files_post + Body_register_benchmark_v1alpha_eval_benchmarks_post: + properties: + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - scoring_functions + title: Body_register_benchmark_v1alpha_eval_benchmarks_post + Body_register_scoring_function_v1_scoring_functions_post: + properties: + return_type: + anyOf: + - $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: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: Params + type: object + required: + - return_type + title: Body_register_scoring_function_v1_scoring_functions_post + Body_register_tool_group_v1_toolgroups_post: + properties: + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: Body_register_tool_group_v1_toolgroups_post + Chunk-Input: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + Chunk-Output: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + type: array + title: list[ImageContentItem-Output | TextContentItem] + title: string | list[ImageContentItem-Output | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + ConversationItemInclude: + type: string + enum: + - web_search_call.action.sources + - code_interpreter_call.outputs + - computer_call_output.output.image_url + - file_search_call.results + - message.input_image.image_url + - message.output_text.logprobs + - reasoning.encrypted_content + title: ConversationItemInclude + description: Specify additional output data to include in the model response. + ConversationsByConversationIdItemsPostRequest: + properties: + items: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + title: Items + type: object + required: + - items + title: ConversationsByConversationIdItemsPostRequest + ConversationsByConversationIdPostRequest: + properties: + metadata: + additionalProperties: + type: string + type: object + title: Metadata + type: object + required: + - metadata + title: ConversationsByConversationIdPostRequest + ConversationsPostRequest: + properties: + items: + anyOf: + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + - type: 'null' + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + type: object + title: ConversationsPostRequest + DatasetPurpose: + type: string + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + description: Purpose of the dataset. Each purpose has a required input data schema. + Errors: + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + object: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: Errors + HealthStatus: + type: string + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + ImageContentItem-Input: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + ImageContentItem-Output: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + InputTokensDetails: + properties: + cached_tokens: + type: integer + title: Cached Tokens + additionalProperties: true + type: object + required: + - cached_tokens + title: InputTokensDetails + JobStatus: + type: string + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + description: Status of a job execution. + MCPListToolsTool: + properties: + input_schema: + additionalProperties: true + type: object + title: Input Schema + name: + type: string + title: Name + description: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_schema + - name + title: MCPListToolsTool + description: Tool definition returned by MCP list tools operation. + ModelsPostRequest: + properties: + model_id: + type: string + title: Model Id + provider_model_id: + anyOf: + - type: string + - type: 'null' + provider_id: + anyOf: + - type: string + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + model_type: + anyOf: + - $ref: '#/components/schemas/ModelType' + title: ModelType + - type: 'null' + title: ModelType + type: object + required: + - model_id + title: ModelsPostRequest + ModerationsPostRequest: + properties: + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + model: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input + title: ModerationsPostRequest + OpenAIAssistantMessageParam-Input: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIAssistantMessageParam-Output: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIChatCompletionUsageCompletionTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. + OpenAIChatCompletionUsagePromptTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. + OpenAIResponseMessage-Input: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseMessage-Output: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseOutputMessageFileSearchToolCallResults: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + file_id: + type: string + title: File Id + filename: + type: string + title: Filename + score: + type: number + title: Score + text: + type: string + title: Text + type: object + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + OpenAIResponseTextFormat: + 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' + type: object + title: OpenAIResponseTextFormat + description: Configuration for Responses API text format. + OpenAIResponseUsageInputTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageInputTokensDetails + description: Token details for input tokens in OpenAI response usage. + OpenAIResponseUsageOutputTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageOutputTokensDetails + description: Token details for output tokens in OpenAI response usage. + OpenAIUserMessageParam-Input: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OpenAIUserMessageParam-Output: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OutputTokensDetails: + properties: + reasoning_tokens: + type: integer + title: Reasoning Tokens + additionalProperties: true + type: object + required: + - reasoning_tokens + title: OutputTokensDetails + PromptsByPromptIdPostRequest: + properties: + prompt: + type: string + title: Prompt + version: + type: integer + title: Version + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + set_as_default: + type: boolean + title: Set As Default + default: true + type: object + required: + - prompt + - version + title: PromptsByPromptIdPostRequest + PromptsByPromptIdSetDefaultVersionPostRequest: + properties: + version: + type: integer + title: Version + type: object + required: + - version + title: PromptsByPromptIdSetDefaultVersionPostRequest + PromptsPostRequest: + properties: + prompt: + type: string + title: Prompt + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + required: + - prompt + title: PromptsPostRequest + ResponsesPostRequest: + properties: + input: + anyOf: + - type: string + - items: + anyOf: + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input + type: array + title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + model: + type: string + title: Model + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + title: OpenAIResponsePrompt + instructions: + anyOf: + - type: string + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + conversation: + anyOf: + - type: string + - type: 'null' + store: + anyOf: + - type: boolean + - type: 'null' + default: true + stream: + anyOf: + - type: boolean + - type: 'null' + default: false + temperature: + anyOf: + - type: number + - type: 'null' + text: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseText' + title: OpenAIResponseText + - type: 'null' + title: OpenAIResponseText + tools: + anyOf: + - items: + 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 + discriminator: + propertyName: type + 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' + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + include: + anyOf: + - items: + type: string + type: array + - type: 'null' + max_infer_iters: + anyOf: + - type: integer + - type: 'null' + default: 10 + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - input + - model + title: ResponsesPostRequest + SafetyRunShieldPostRequest: + properties: + shield_id: + type: string + title: Shield Id + messages: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array + title: Messages + params: + additionalProperties: true + type: object + title: Params + type: object + required: + - shield_id + - messages + - params + title: SafetyRunShieldPostRequest + ScoringScoreBatchPostRequest: + properties: + dataset_id: + type: string + title: Dataset Id + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + save_results_dataset: + type: boolean + title: Save Results Dataset + default: false + type: object + required: + - dataset_id + - scoring_functions + title: ScoringScoreBatchPostRequest + ScoringScorePostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + type: object + required: + - input_rows + - scoring_functions + title: ScoringScorePostRequest + SearchRankingOptions: + properties: + ranker: + anyOf: + - type: string + - type: 'null' + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + type: object + title: SearchRankingOptions + description: Options for ranking and filtering search results. + ShieldsPostRequest: + properties: + shield_id: + type: string + title: Shield Id + provider_shield_id: + anyOf: + - type: string + - type: 'null' + provider_id: + anyOf: + - type: string + - type: 'null' + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - shield_id + title: ShieldsPostRequest + ToolRuntimeInvokePostRequest: + properties: + tool_name: + type: string + title: Tool Name + kwargs: + additionalProperties: true + type: object + title: Kwargs + authorization: + anyOf: + - type: string + - type: 'null' + type: object + required: + - tool_name + - kwargs + title: ToolRuntimeInvokePostRequest + V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + benchmark_config: + $ref: '#/components/schemas/BenchmarkConfig' + type: object + required: + - input_rows + - scoring_functions + - benchmark_config + title: V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest + V1AlphaInferenceRerankPostRequest: + properties: + model: + type: string + title: Model + query: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + items: + items: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + type: array + title: Items + max_num_results: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - model + - query + - items + title: V1AlphaInferenceRerankPostRequest + V1AlphaPostTrainingPreferenceOptimizePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + finetuned_model: + type: string + title: Finetuned Model + algorithm_config: + $ref: '#/components/schemas/DPOAlignmentConfig' + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + type: object + required: + - job_uuid + - finetuned_model + - algorithm_config + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingPreferenceOptimizePostRequest + V1AlphaPostTrainingSupervisedFineTunePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + model: + anyOf: + - type: string + - type: 'null' + description: Model descriptor for training if not in provider config` + checkpoint_dir: + anyOf: + - type: string + - type: 'null' + algorithm_config: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LoraFinetuningConfig' + title: LoraFinetuningConfig + - $ref: '#/components/schemas/QATFinetuningConfig' + title: QATFinetuningConfig + discriminator: + propertyName: type + mapping: + LoRA: '#/components/schemas/LoraFinetuningConfig' + QAT: '#/components/schemas/QATFinetuningConfig' + title: LoraFinetuningConfig | QATFinetuningConfig + - type: 'null' + title: Algorithm Config + type: object + required: + - job_uuid + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingSupervisedFineTunePostRequest + V1BetaDatasetsPostRequestLoose: + properties: + purpose: + title: Purpose + source: + title: Source + metadata: + title: Metadata + dataset_id: + title: Dataset Id + type: object + required: + - purpose + - source + title: V1BetaDatasetsPostRequestLoose + VectorIoQueryPostRequest: + properties: + vector_store_id: + type: string + title: Vector Store Id + query: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - vector_store_id + - query + title: VectorIoQueryPostRequest + VectorStoresByVectorStoreIdFilesByFileIdPostRequest: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + type: object + required: + - attributes + title: VectorStoresByVectorStoreIdFilesByFileIdPostRequest + VectorStoresByVectorStoreIdFilesPostRequest: + properties: + file_id: + type: string + title: File Id + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + chunking_strategy: + anyOf: + - oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + type: object + required: + - file_id + title: VectorStoresByVectorStoreIdFilesPostRequest + VectorStoresByVectorStoreIdPostRequest: + properties: + name: + anyOf: + - type: string + - type: 'null' + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: VectorStoresByVectorStoreIdPostRequest + VectorStoresByVectorStoreIdSearchPostRequest: + 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' + max_num_results: + anyOf: + - type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + title: SearchRankingOptions + rewrite_query: + anyOf: + - type: boolean + - type: 'null' + default: false + search_mode: + anyOf: + - type: string + - type: 'null' + default: vector + type: object + required: + - query + title: VectorStoresByVectorStoreIdSearchPostRequest _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 + title: _URLOrData + description: A URL or a base64 encoded string SamplingStrategy: discriminator: mapping: @@ -9741,99 +12088,6 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat - 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 - 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 - 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 - 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 OpenAIResponseContentPart: discriminator: mapping: @@ -9849,56 +12103,6 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText - 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 - 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 SpanEndPayload: description: Payload for a span end event. properties: @@ -10120,110 +12324,6 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - 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 ImageDelta: description: An image content delta for streaming responses. properties: @@ -10255,16 +12355,6 @@ components: - text title: TextDelta type: object - JobStatus: - description: Status of a job execution. - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - type: string MetricInResponse: description: A metric value included in API responses. properties: @@ -10380,14 +12470,6 @@ components: - 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 Api: description: Enumeration of all available APIs in the Llama Stack system. enum: @@ -10716,26 +12798,6 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig 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 OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -10906,13 +12968,6 @@ components: - content title: UserMessage type: object - HealthStatus: - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - type: string PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -11093,3 +13148,131 @@ components: - query title: VectorStoreSearchRequest type: object + 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' +tags: +- description: APIs for creating and interacting with agentic systems. + name: Agents + x-displayName: Agents +- description: |- + The API is designed to allow use of openai client libraries for seamless integration. + + This API provides the following extensions: + - idempotent batch creation + + Note: This API is currently under active development and may undergo changes. + name: Batches + x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale. +- description: '' + name: Benchmarks +- description: Protocol for conversation management operations. + name: Conversations + x-displayName: Conversations +- description: '' + name: DatasetIO +- description: '' + name: Datasets +- description: Llama Stack Evaluation API for running evaluations on model and agent candidates. + name: Eval + x-displayName: Evaluations +- description: This API is used to upload documents that can be used with other Llama Stack APIs. + name: Files + x-displayName: Files +- description: |- + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Three kinds of models are supported: + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. + - Rerank models: these models reorder the documents based on their relevance to a query. + name: Inference + x-displayName: Inference +- description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers. + name: Inspect + x-displayName: Inspect +- description: '' + name: Models +- description: '' + name: PostTraining (Coming Soon) +- description: Protocol for prompt management operations. + name: Prompts + x-displayName: Prompts +- description: Providers API for inspecting, listing, and modifying providers and their configurations. + name: Providers + x-displayName: Providers +- description: OpenAI-compatible Moderations API. + name: Safety + x-displayName: Safety +- description: '' + name: Scoring +- description: '' + name: ScoringFunctions +- description: '' + name: Shields +- description: '' + name: ToolGroups +- description: '' + name: ToolRuntime +- description: '' + name: VectorIO +x-tagGroups: +- name: Operations + tags: + - Agents + - Batches + - Benchmarks + - Conversations + - DatasetIO + - Datasets + - Eval + - Files + - Inference + - Inspect + - Models + - PostTraining (Coming Soon) + - Prompts + - Providers + - Safety + - Scoring + - ScoringFunctions + - Shields + - ToolGroups + - ToolRuntime + - VectorIO +security: +- Default: [] diff --git a/docs/static/deprecated-llama-stack-spec.yaml b/docs/static/deprecated-llama-stack-spec.yaml index b306799d1..06112396f 100644 --- a/docs/static/deprecated-llama-stack-spec.yaml +++ b/docs/static/deprecated-llama-stack-spec.yaml @@ -15,16 +15,38 @@ servers: paths: /v1/models: get: + responses: + '200': + description: A OpenAIListModelsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIListModelsResponse' + '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' tags: - Models summary: Openai List Models + description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get + post: responses: '200': - description: Successful Response + description: A Model. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Model' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -37,36 +59,58 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Models summary: Register Model + description: |- + Register model. + + Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModelsPostRequest' + required: true deprecated: true /v1/models/{model_id}: get: + responses: + '200': + description: A Model. + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + '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' tags: - Models summary: Get Model + description: |- + Get model. + + Get a model by its identifier. operationId: get_model_v1_models__model_id__get + parameters: + - name: model_id + in: path + required: true + schema: + type: string + description: 'Path parameter: model_id' + delete: responses: '200': description: Successful Response @@ -85,37 +129,14 @@ paths: 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 + description: |- + Unregister model. + + Unregister a 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 @@ -123,12 +144,34 @@ paths: schema: type: string description: 'Path parameter: model_id' + deprecated: true /v1/scoring-functions: get: + responses: + '200': + description: A ListScoringFunctionsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListScoringFunctionsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Scoring Functions summary: List Scoring Functions + description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get + post: responses: '200': description: Successful Response @@ -136,47 +179,63 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Scoring Functions summary: Register Scoring Function + description: Register a 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_scoring_function_v1_scoring_functions_post' deprecated: true /v1/scoring-functions/{scoring_fn_id}: get: + responses: + '200': + description: A ScoringFn. + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringFn' + '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' tags: - Scoring Functions summary: Get Scoring Function + description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get + parameters: + - name: scoring_fn_id + in: path + required: true + schema: + type: string + description: 'Path parameter: scoring_fn_id' + delete: responses: '200': description: Successful Response @@ -195,37 +254,11 @@ paths: 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 + description: Unregister a 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 @@ -233,18 +266,41 @@ paths: schema: type: string description: 'Path parameter: scoring_fn_id' + deprecated: true /v1/shields: get: + responses: + '200': + description: A ListShieldsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListShieldsResponse' + '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' tags: - Shields summary: List Shields + description: List all shields. operationId: list_shields_v1_shields_get + post: responses: '200': - description: Successful Response + description: A Shield. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Shield' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -257,36 +313,52 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Shields summary: Register Shield + description: Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldsPostRequest' + required: true deprecated: true /v1/shields/{identifier}: get: + responses: + '200': + description: A Shield. + content: + application/json: + schema: + $ref: '#/components/schemas/Shield' + '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' tags: - Shields summary: Get Shield + description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get + parameters: + - name: identifier + in: path + required: true + schema: + type: string + description: 'Path parameter: identifier' + delete: responses: '200': description: Successful Response @@ -305,37 +377,11 @@ paths: 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 + description: Unregister a 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 @@ -343,12 +389,34 @@ paths: schema: type: string description: 'Path parameter: identifier' + deprecated: true /v1/toolgroups: get: + responses: + '200': + description: A ListToolGroupsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolGroupsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tool Groups + description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get + post: responses: '200': description: Successful Response @@ -356,47 +424,62 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Tool Groups summary: Register Tool Group + description: Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_tool_group_v1_toolgroups_post' deprecated: true /v1/toolgroups/{toolgroup_id}: get: + responses: + '200': + description: A ToolGroup. + content: + application/json: + schema: + $ref: '#/components/schemas/ToolGroup' + '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' tags: - Tool Groups summary: Get Tool Group + description: Get a tool group by its ID. operationId: get_tool_group_v1_toolgroups__toolgroup_id__get + parameters: + - name: toolgroup_id + in: path + required: true + schema: + type: string + description: 'Path parameter: toolgroup_id' + delete: responses: '200': description: Successful Response @@ -415,37 +498,11 @@ paths: 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 + description: Unregister a tool group. 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 @@ -453,18 +510,41 @@ paths: schema: type: string description: 'Path parameter: toolgroup_id' + deprecated: true /v1beta/datasets: get: + responses: + '200': + description: A ListDatasetsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListDatasetsResponse' + '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' tags: - Datasets summary: List Datasets + description: List all datasets. operationId: list_datasets_v1beta_datasets_get + post: responses: '200': - description: Successful Response + description: A Dataset. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Dataset' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -477,36 +557,52 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Datasets summary: Register Dataset + description: Register a new 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1BetaDatasetsPostRequestLoose' + required: true deprecated: true /v1beta/datasets/{dataset_id}: get: + responses: + '200': + description: A Dataset. + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + '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' tags: - Datasets summary: Get Dataset + description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get + parameters: + - name: dataset_id + in: path + required: true + schema: + type: string + description: 'Path parameter: dataset_id' + delete: responses: '200': description: Successful Response @@ -525,37 +621,11 @@ paths: 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 + description: Unregister a dataset by its ID. 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 @@ -563,12 +633,34 @@ paths: schema: type: string description: 'Path parameter: dataset_id' + deprecated: true /v1alpha/eval/benchmarks: get: + responses: + '200': + description: A ListBenchmarksResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBenchmarksResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Benchmarks summary: List Benchmarks + description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get + post: responses: '200': description: Successful Response @@ -576,53 +668,38 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Benchmarks summary: Register Benchmark + description: Register a 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_benchmark_v1alpha_eval_benchmarks_post' deprecated: true /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 + description: A Benchmark. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Benchmark' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -635,6 +712,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Benchmarks + summary: Get Benchmark + description: Get a benchmark by its ID. + operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get parameters: - name: benchmark_id in: path @@ -643,10 +725,6 @@ paths: 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 @@ -665,7 +743,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - deprecated: true + tags: + - Benchmarks + summary: Unregister Benchmark + description: Unregister a benchmark. + operationId: unregister_benchmark_v1alpha_eval_benchmarks__benchmark_id__delete parameters: - name: benchmark_id in: path @@ -673,44 +755,8 @@ paths: schema: type: string description: 'Path parameter: benchmark_id' + deprecated: true 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: Error: description: Error response from the API. Roughly follows RFC 7807. @@ -736,63 +782,61 @@ components: title: Error type: object ListBatchesResponse: - description: Response containing a list of batch objects. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: - description: List of batch objects items: $ref: '#/components/schemas/Batch' - title: Data type: array + title: Data + description: List of batch objects 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 + title: Has More + description: Whether there are more batches available + default: false + type: object required: - data title: ListBatchesResponse - type: object + description: Response containing a list of batch objects. Batch: - additionalProperties: true properties: id: + type: string title: Id - type: string completion_window: + type: string title: Completion Window - type: string created_at: - title: Created At type: integer + title: Created At endpoint: + type: string title: Endpoint - type: string input_file_id: - title: Input File Id type: string + title: Input File Id object: + type: string const: batch title: Object - type: string status: + type: string enum: - validating - failed @@ -803,90 +847,76 @@ components: - 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 + additionalProperties: true + type: object required: - id - completion_window @@ -896,36 +926,42 @@ components: - object - status title: Batch - type: object + Order: + type: string + enum: + - asc + - desc + title: Order + description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: - description: Response from listing OpenAI-compatible chat completions. properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse - type: object + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: @@ -959,19 +995,19 @@ components: title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionContentPartImageParam: - description: Image content part for OpenAI-compatible chat completion messages. properties: type: - const: image_url - default: image_url - title: Type type: string + const: image_url + title: Type + default: image_url image_url: $ref: '#/components/schemas/OpenAIImageURL' + type: object required: - image_url title: OpenAIChatCompletionContentPartImageParam - type: object + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -988,139 +1024,130 @@ components: title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIChatCompletionContentPartTextParam: - description: Text content part for OpenAI-compatible chat completion messages. properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: OpenAIChatCompletionContentPartTextParam - type: object + description: Text content part for OpenAI-compatible chat completion messages. 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 + const: function + title: Type + default: function function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' - nullable: true title: OpenAIChatCompletionToolCallFunction - title: OpenAIChatCompletionToolCall type: object + title: OpenAIChatCompletionToolCall + description: Tool call specification for OpenAI-compatible chat completion responses. 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 + title: OpenAIChatCompletionToolCallFunction + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: - description: Usage information for OpenAI chat completion. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer completion_tokens: + type: integer title: Completion Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage - type: object + description: Usage information for OpenAI chat completion. 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + title: OpenAIUserMessageParam-Output | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' finish_reason: - title: Finish Reason type: string + title: Finish Reason index: - title: Index type: integer + title: Index logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' - nullable: true title: OpenAIChoiceLogprobs + type: object required: - message - finish_reason - index title: OpenAIChoice - type: object + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. properties: content: anyOf: @@ -1128,24 +1155,22 @@ components: $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 + title: OpenAIChoiceLogprobs + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: - description: A message from the developer in an OpenAI-compatible chat completion request. properties: role: - const: developer - default: developer - title: Role type: string + const: developer + title: Role + default: developer content: anyOf: - type: string @@ -1158,58 +1183,54 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAIDeveloperMessageParam - type: object + description: A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: properties: type: - const: file - default: file - title: Type type: string + const: file + title: Type + default: file file: $ref: '#/components/schemas/OpenAIFileFile' + type: object 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 + title: OpenAIFileFile OpenAIImageURL: - description: Image URL specification for OpenAI-compatible chat completion messages. properties: url: - title: Url type: string + title: Url detail: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - url title: OpenAIImageURL - type: object + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: discriminator: mapping: @@ -1232,13 +1253,12 @@ components: title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAISystemMessageParam: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string @@ -1251,12 +1271,36 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAISystemMessageParam - type: object + description: A system message providing instructions or context to the model. OpenAITokenLogProb: + properties: + token: + type: string + title: Token + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + logprob: + type: number + title: Logprob + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + type: array + title: Top Logprobs + type: object + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb description: |- The log probability for a token from an OpenAI-compatible chat completion response. @@ -1264,42 +1308,16 @@ components: :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 OpenAIToolMessageParam: - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. properties: role: + type: string const: tool - default: tool title: Role - type: string + default: tool tool_call_id: - title: Tool Call Id type: string + title: Tool Call Id content: anyOf: - type: string @@ -1308,37 +1326,37 @@ components: type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] + type: object required: - tool_call_id - content title: OpenAIToolMessageParam - type: object + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. 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 + title: Token bytes: anyOf: - items: type: integer type: array - type: 'null' - nullable: true logprob: - title: Logprob type: number + title: Logprob + type: object required: - token - logprob title: OpenAITopLogProb - type: object + 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 OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -1378,11 +1396,10 @@ components: title: OpenAIUserMessageParam type: object OpenAIJSONSchema: - description: JSON schema specification for OpenAI-compatible structured response format. properties: name: - title: Name type: string + title: Name description: anyOf: - type: string @@ -1396,32 +1413,33 @@ components: - additionalProperties: true type: object - type: 'null' + type: object title: OpenAIJSONSchema - type: object + description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: - description: JSON object response format for OpenAI-compatible chat completion requests. properties: type: + type: string const: json_object - default: json_object title: Type - type: string - title: OpenAIResponseFormatJSONObject + default: json_object type: object + title: OpenAIResponseFormatJSONObject + description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: - description: JSON schema response format for OpenAI-compatible chat completion requests. properties: type: - const: json_schema - default: json_schema - title: Type type: string + const: json_schema + title: Type + default: json_schema json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' + type: object required: - json_schema title: OpenAIResponseFormatJSONSchema - type: object + description: JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: discriminator: mapping: @@ -1438,52 +1456,49 @@ components: title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject OpenAIResponseFormatText: - description: Text response format for OpenAI-compatible chat completion requests. properties: type: - const: text - default: text - title: Type type: string - title: OpenAIResponseFormatText + const: text + title: Type + default: text type: object + title: OpenAIResponseFormatText + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible chat completion endpoint. properties: model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array minItems: 1 title: Messages - type: array frequency_penalty: anyOf: - type: number - type: 'null' - nullable: true function_call: anyOf: - type: string @@ -1491,7 +1506,6 @@ components: type: object - type: 'null' title: string | object - nullable: true functions: anyOf: - items: @@ -1499,68 +1513,58 @@ components: 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: + - oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject + discriminator: + propertyName: type + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format - nullable: true seed: anyOf: - type: integer - type: 'null' - nullable: true stop: anyOf: - type: string @@ -1570,23 +1574,19 @@ components: 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 @@ -1594,7 +1594,6 @@ components: type: object - type: 'null' title: string | object - nullable: true tools: anyOf: - items: @@ -1602,63 +1601,60 @@ components: 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 + additionalProperties: true + type: object required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: - description: Response from an OpenAI-compatible chat completion request. properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' - nullable: true title: OpenAIChatCompletionUsage + type: object required: - id - choices - created - model title: OpenAIChatCompletion - type: object + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: @@ -1754,55 +1750,55 @@ components: OpenAICompletionWithInputMessages: properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Input Messages + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output | ... (5 variants) type: array + title: Input Messages + type: object required: - id - choices @@ -1810,14 +1806,11 @@ components: - model - input_messages title: OpenAICompletionWithInputMessages - type: object OpenAICompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible completion endpoint. properties: model: - title: Model type: string + title: Model prompt: anyOf: - type: string @@ -1840,49 +1833,40 @@ components: 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 @@ -1892,44 +1876,66 @@ components: 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 + additionalProperties: true + type: object required: - model - prompt title: OpenAICompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: + properties: + id: + type: string + title: Id + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + type: array + title: Choices + created: + type: integer + title: Created + model: + type: string + title: Model + object: + type: string + const: text_completion + title: Object + default: text_completion + type: object + required: + - id + - choices + - created + - model + title: OpenAICompletion description: |- Response from an OpenAI-compatible completion request. @@ -1938,34 +1944,29 @@ components: :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 OpenAICompletionChoice: + properties: + finish_reason: + type: string + title: Finish Reason + text: + type: string + title: Text + index: + type: integer + title: Index + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + title: OpenAIChoiceLogprobs + type: object + required: + - finish_reason + - text + - index + title: OpenAICompletionChoice description: |- A choice from an OpenAI-compatible completion response. @@ -1973,29 +1974,6 @@ components: :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 ConversationItem: discriminator: mapping: @@ -2030,54 +2008,55 @@ components: title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) OpenAIResponseAnnotationCitation: - description: URL citation annotation for referencing external web resources. properties: type: + type: string const: url_citation - default: url_citation title: Type - type: string + default: url_citation end_index: + type: integer title: End Index - type: integer start_index: - title: Start Index type: integer + title: Start Index title: + type: string title: Title - type: string url: - title: Url type: string + title: Url + type: object required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation - type: object + description: URL citation annotation for referencing external web resources. OpenAIResponseAnnotationContainerFileCitation: properties: type: + type: string const: container_file_citation - default: container_file_citation title: Type - type: string + default: container_file_citation container_id: + type: string title: Container Id - type: string end_index: + type: integer title: End Index - type: integer file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename start_index: - title: Start Index type: integer + title: Start Index + type: object required: - container_id - end_index @@ -2085,48 +2064,47 @@ components: - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation - type: object OpenAIResponseAnnotationFileCitation: - description: File citation annotation for referencing specific files in response content. properties: type: + type: string const: file_citation - default: file_citation title: Type - type: string + default: file_citation file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename index: - title: Index type: integer + title: Index + type: object required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation - type: object + description: File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: properties: type: + type: string const: file_path - default: file_path title: Type - type: string + default: file_path file_id: - title: File Id type: string + title: File Id index: - title: Index type: integer + title: Index + type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath - type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -2146,49 +2124,47 @@ components: title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: - description: Refusal content within a streamed response part. properties: type: + type: string const: refusal - default: refusal title: Type - type: string + default: refusal refusal: - title: Refusal type: string + title: Refusal + type: object required: - refusal title: OpenAIResponseContentPartRefusal - type: object + description: Refusal content within a streamed response part. OpenAIResponseInputFunctionToolCallOutput: - description: This represents the output of a function call that gets passed back to the model. properties: call_id: + type: string title: Call Id - type: string output: + type: string title: Output - type: string type: - const: function_call_output - default: function_call_output - title: Type type: string + const: function_call_output + title: Type + default: function_call_output id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput - type: object + description: This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: discriminator: mapping: @@ -2205,134 +2181,126 @@ components: title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseInputMessageContentFile: - description: File content for input messages in OpenAI response format. properties: type: - const: input_file - default: input_file - title: Type type: string + const: input_file + title: Type + default: input_file 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 + title: OpenAIResponseInputMessageContentFile + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: - description: Image content for input messages in OpenAI response format. properties: detail: - default: auto title: Detail + default: auto type: string enum: - low - high - auto type: - const: input_image - default: input_image - title: Type type: string + const: input_image + title: Type + default: input_image file_id: anyOf: - type: string - type: 'null' - nullable: true image_url: anyOf: - type: string - type: 'null' - nullable: true - title: OpenAIResponseInputMessageContentImage type: object + title: OpenAIResponseInputMessageContentImage + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: - description: Text content for input messages in OpenAI response format. properties: text: + type: string title: Text - type: string type: - const: input_text - default: input_text - title: Type type: string + const: input_text + title: Type + default: input_text + type: object required: - text title: OpenAIResponseInputMessageContentText - type: object + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: - description: A request for human approval of a tool invocation. properties: arguments: + type: string title: Arguments - type: string id: + type: string title: Id - type: string name: + type: string title: Name - type: string server_label: + type: string title: Server Label - type: string type: - const: mcp_approval_request - default: mcp_approval_request - title: Type type: string + const: mcp_approval_request + title: Type + default: mcp_approval_request + type: object required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest - type: object + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: - description: A response to an MCP approval request. properties: approval_request_id: + type: string title: Approval Request Id - type: string approve: - title: Approve type: boolean + title: Approve type: - const: mcp_approval_response - default: mcp_approval_response - title: Type type: string + const: mcp_approval_response + title: Type + default: mcp_approval_response id: anyOf: - type: string - type: 'null' - nullable: true reason: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse - type: object + description: A response to an MCP approval request. OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -2419,22 +2387,15 @@ components: OpenAIResponseOutputMessageContentOutputText: properties: text: + type: string title: Text - type: string type: - const: output_text - default: output_text - title: Type type: string + const: output_text + title: Type + default: output_text 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 @@ -2444,176 +2405,177 @@ components: title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath + discriminator: + propertyName: type + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - title: Annotations type: array + title: Annotations + type: object required: - text title: OpenAIResponseOutputMessageContentOutputText - type: object OpenAIResponseOutputMessageFileSearchToolCall: - description: File search tool call output message for OpenAI responses. properties: id: - title: Id type: string + title: Id queries: items: type: string - title: Queries type: array + title: Queries status: + type: string title: Status - type: string type: - const: file_search_call - default: file_search_call - title: Type type: string + const: file_search_call + title: Type + default: file_search_call results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' - nullable: true + type: object required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall - type: object + description: File search tool call output message for OpenAI responses. OpenAIResponseOutputMessageFunctionToolCall: - description: Function tool call output message for OpenAI responses. properties: call_id: + type: string title: Call Id - type: string name: + type: string title: Name - type: string arguments: + type: string title: Arguments - type: string type: - const: function_call - default: function_call - title: Type type: string + const: function_call + title: Type + default: function_call id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall - type: object + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: - description: Model Context Protocol (MCP) call output message for OpenAI responses. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_call - default: mcp_call title: Type - type: string + default: mcp_call arguments: + type: string title: Arguments - type: string name: + type: string title: Name - type: string server_label: - title: Server Label type: string + title: Server Label error: anyOf: - type: string - type: 'null' - nullable: true output: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall - type: object + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: - description: MCP list tools output message containing available tools from an MCP server. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_list_tools - default: mcp_list_tools title: Type - type: string + default: mcp_list_tools server_label: - title: Server Label type: string + title: Server Label tools: items: $ref: '#/components/schemas/MCPListToolsTool' - title: Tools type: array + title: Tools + type: object required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools - type: object + description: MCP list tools output message containing available tools from an MCP server. OpenAIResponseOutputMessageWebSearchToolCall: - description: Web search tool call output message for OpenAI responses. properties: id: + type: string title: Id - type: string status: + type: string title: Status - type: string type: - const: web_search_call - default: web_search_call - title: Type type: string + const: web_search_call + title: Type + default: web_search_call + type: object required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall - type: object + description: Web search tool call output message for OpenAI responses. Conversation: - description: OpenAI-compatible conversation object. properties: id: - description: The unique ID of the conversation. + type: string title: Id - type: string + description: The unique ID of the conversation. object: - const: conversation - default: conversation - description: The object type, which is always conversation. - title: Object type: string + const: conversation + title: Object + description: The object type, which is always conversation. + default: conversation created_at: - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - title: Created At type: integer + title: Created At + description: The time at which the conversation was created, measured in seconds since the Unix epoch. metadata: anyOf: - additionalProperties: @@ -2621,7 +2583,6 @@ components: 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: @@ -2630,59 +2591,45 @@ components: 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 + type: object required: - id - created_at title: Conversation - type: object + description: OpenAI-compatible conversation object. ConversationDeletedResource: - description: Response for deleted conversation. properties: id: - description: The deleted conversation identifier + type: string title: Id - type: string + description: The deleted conversation identifier object: - default: conversation.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationDeletedResource - type: object + description: Response for deleted conversation. ConversationItemList: - description: List of conversation items with pagination. properties: object: - default: list - description: Object type - title: Object type: string + title: Object + description: Object type + default: list 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -2699,58 +2646,68 @@ components: title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - title: Data + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (9 variants) type: array + title: Data + description: List of conversation items 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 + title: Has More + description: Whether there are more items available + default: false + type: object required: - data title: ConversationItemList - type: object + description: List of conversation items with pagination. ConversationItemDeletedResource: - description: Response for deleted conversation item. properties: id: - description: The deleted item identifier + type: string title: Id - type: string + description: The deleted item identifier object: - default: conversation.item.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.item.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationItemDeletedResource - type: object + description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible embeddings endpoint. properties: model: - title: Model type: string + title: Model input: anyOf: - type: string @@ -2768,25 +2725,24 @@ components: anyOf: - type: integer - type: 'null' - nullable: true user: anyOf: - type: string - type: 'null' - nullable: true + additionalProperties: true + type: object required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: - description: A single embedding data object from an OpenAI-compatible embeddings response. properties: object: - const: embedding - default: embedding - title: Object type: string + const: embedding + title: Object + default: embedding embedding: anyOf: - items: @@ -2796,112 +2752,113 @@ components: - type: string title: list[number] | string index: - title: Index type: integer + title: Index + type: object required: - embedding - index title: OpenAIEmbeddingData - type: object + description: A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: - description: Usage information for an OpenAI-compatible embeddings response. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens + type: object required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage - type: object + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: - description: Response from an OpenAI-compatible embeddings request. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' - title: Data type: array + title: Data model: - title: Model type: string + title: Model usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' + type: object required: - data - model - usage title: OpenAIEmbeddingsResponse - type: object + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: - description: Valid purpose values for OpenAI Files API. + type: string enum: - assistants - batch title: OpenAIFilePurpose - type: string + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: - description: Response for listing files in OpenAI Files API. properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse - type: object + description: Response for listing files in OpenAI Files API. OpenAIFileObject: - description: OpenAI File object as defined in the OpenAI Files API. properties: object: + type: string const: file - default: file title: Object - type: string + default: file id: + type: string title: Id - type: string bytes: + type: integer title: Bytes - type: integer created_at: + type: integer title: Created At - type: integer expires_at: - title: Expires At type: integer + title: Expires At filename: - title: Filename type: string + title: Filename purpose: $ref: '#/components/schemas/OpenAIFilePurpose' + type: object required: - id - bytes @@ -2910,90 +2867,119 @@ components: - filename - purpose title: OpenAIFileObject - type: object + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: + properties: + anchor: + type: string + const: created_at + title: Anchor + seconds: + type: integer + maximum: 2592000.0 + minimum: 3600.0 + title: Seconds + type: object + required: + - anchor + - seconds + title: 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 OpenAIFileDeleteResponse: - description: Response for deleting a file in OpenAI Files API. properties: id: + type: string title: Id - type: string object: - const: file - default: file - title: Object type: string + const: file + title: Object + default: file deleted: - title: Deleted type: boolean + title: Deleted + type: object required: - id - deleted title: OpenAIFileDeleteResponse + description: Response for deleting a file in OpenAI Files API. + Response: + title: Response type: object HealthInfo: - description: Health status information for the service. properties: status: $ref: '#/components/schemas/HealthStatus' + type: object required: - status title: HealthInfo - type: object + description: Health status information for the service. RouteInfo: - description: Information about an API route including its path, method, and implementing providers. properties: route: + type: string title: Route - type: string method: - title: Method type: string + title: Method provider_types: items: type: string - title: Provider Types type: array + title: Provider Types + type: object required: - route - method - provider_types title: RouteInfo - type: object + description: Information about an API route including its path, method, and implementing providers. ListRoutesResponse: - description: Response containing a list of all available API routes. properties: data: items: $ref: '#/components/schemas/RouteInfo' - title: Data type: array + title: Data + type: object required: - data title: ListRoutesResponse - type: object + description: Response containing a list of all available API routes. OpenAIModel: + properties: + id: + type: string + title: Id + object: + type: string + const: model + title: Object + default: model + created: + type: integer + title: Created + owned_by: + type: string + title: Owned By + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - id + - created + - owned_by + title: OpenAIModel description: |- A model from OpenAI. @@ -3002,120 +2988,90 @@ components: :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 + title: Data + type: object required: - data title: OpenAIListModelsResponse - type: object 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: model - default: model - title: Type type: string + const: model + title: Type + default: model metadata: additionalProperties: true - description: Any additional metadata for this model - title: Metadata type: object + title: Metadata + description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm + type: object required: - identifier - provider_id title: Model - type: object + description: A model resource representing an AI model registered in Llama Stack. ModelType: - description: Enumeration of supported model types in Llama Stack. + type: string enum: - llm - embedding - rerank title: ModelType - type: string + description: Enumeration of supported model types in Llama Stack. ModerationObject: - description: A moderation object. properties: id: + type: string title: Id - type: string model: - title: Model type: string + title: Model results: items: $ref: '#/components/schemas/ModerationObjectResults' - title: Results type: array + title: Results + type: object required: - id - model - results title: ModerationObject - type: object - ModerationObjectResults: description: A moderation object. + ModerationObjectResults: properties: flagged: - title: Flagged type: boolean + title: Flagged categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' - nullable: true category_applied_input_types: anyOf: - additionalProperties: @@ -3124,93 +3080,90 @@ components: 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 + title: Metadata + type: object required: - flagged title: ModerationObjectResults - type: object + description: A moderation 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 + minimum: 1.0 + title: Version + description: Version (integer starting at 1, incremented on save) prompt_id: - description: Unique identifier in format 'pmpt_<48-digit-hash>' - title: Prompt Id type: string + title: Prompt Id + description: Unique identifier in format 'pmpt_<48-digit-hash>' variables: - description: List of variable names that can be used in the prompt template items: type: string - title: Variables type: array + title: Variables + description: List of variable names that can be used in the prompt template is_default: - default: false - description: Boolean indicating whether this version is the default version - title: Is Default type: boolean + title: Is Default + description: Boolean indicating whether this version is the default version + default: false + type: object required: - version - prompt_id title: Prompt - type: object + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. ListPromptsResponse: - description: Response model to list prompts. properties: data: items: $ref: '#/components/schemas/Prompt' - title: Data type: array + title: Data + type: object required: - data title: ListPromptsResponse - type: object + description: Response model to list prompts. ProviderInfo: - description: Information about a registered provider including its configuration and health status. properties: api: + type: string title: Api - type: string provider_id: + type: string title: Provider Id - type: string provider_type: - title: Provider Type type: string + title: Provider Type config: additionalProperties: true - title: Config type: object + title: Config health: additionalProperties: true - title: Health type: object + title: Health + type: object required: - api - provider_id @@ -3218,62 +3171,62 @@ components: - config - health title: ProviderInfo - type: object + description: Information about a registered provider including its configuration and health status. ListProvidersResponse: - description: Response containing a list of all available providers. properties: data: items: $ref: '#/components/schemas/ProviderInfo' - title: Data type: array + title: Data + type: object required: - data title: ListProvidersResponse - type: object + description: Response containing a list of all available providers. ListOpenAIResponseObject: - description: Paginated list of OpenAI response objects with navigation metadata. properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject - type: object + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: - description: Error details for failed OpenAI response requests. properties: code: + type: string title: Code - type: string message: - title: Message type: string + title: Message + type: object required: - code - message title: OpenAIResponseError - type: object + description: Error details for failed OpenAI response requests. OpenAIResponseInput: anyOf: - discriminator: @@ -3310,29 +3263,27 @@ components: title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage OpenAIResponseInputToolFileSearch: - description: File search tool configuration for OpenAI response inputs. properties: type: - const: file_search - default: file_search - title: Type type: string + const: file_search + title: Type + default: file_search vector_store_ids: items: type: string - title: Vector Store Ids type: array + title: Vector Store Ids filters: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true max_num_results: anyOf: - - maximum: 50 - minimum: 1 - type: integer + - type: integer + maximum: 50.0 + minimum: 1.0 - type: 'null' default: 10 ranking_options: @@ -3340,28 +3291,26 @@ components: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' - nullable: true title: SearchRankingOptions + type: object required: - vector_store_ids title: OpenAIResponseInputToolFileSearch - type: object + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: - description: Function tool configuration for OpenAI response inputs. properties: type: + type: string const: function - default: function title: Type - type: string + default: function name: - title: Name type: string + title: Name description: anyOf: - type: string - type: 'null' - nullable: true parameters: anyOf: - additionalProperties: true @@ -3371,18 +3320,17 @@ components: anyOf: - type: boolean - type: 'null' - nullable: true + type: object required: - name - parameters title: OpenAIResponseInputToolFunction - type: object + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: - description: Web search tool configuration for OpenAI response inputs. properties: type: - default: web_search title: Type + default: web_search type: string enum: - web_search @@ -3391,51 +3339,40 @@ components: - web_search_2025_08_26 search_context_size: anyOf: - - pattern: ^low|medium|high$ - type: string + - type: string + pattern: ^low|medium|high$ - type: 'null' default: medium - title: OpenAIResponseInputToolWebSearch type: object + title: OpenAIResponseInputToolWebSearch + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: - description: OpenAI response object extended with input context information. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -3448,33 +3385,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -3484,20 +3428,9 @@ components: 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 @@ -3507,48 +3440,43 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -3561,16 +3489,27 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Input + type: object required: - created_at - id @@ -3579,7 +3518,7 @@ components: - status - input title: OpenAIResponseObjectWithInput - type: object + description: OpenAI response object extended with input context information. OpenAIResponseOutput: discriminator: mapping: @@ -3608,20 +3547,13 @@ components: title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) OpenAIResponsePrompt: - description: OpenAI compatible Prompt object that is used in OpenAI responses. properties: id: - title: Id type: string + title: Id 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 @@ -3629,31 +3561,35 @@ components: title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' - nullable: true version: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id title: OpenAIResponsePrompt - type: object + description: OpenAI compatible Prompt object that is used in OpenAI responses. 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 + title: OpenAIResponseText + description: Text response configuration for OpenAI responses. OpenAIResponseTool: discriminator: mapping: @@ -3676,16 +3612,15 @@ components: title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: - title: Server Label type: string + title: Server Label allowed_tools: anyOf: - items: @@ -3696,43 +3631,41 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label title: OpenAIResponseToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. OpenAIResponseUsage: - description: Usage information for OpenAI response. properties: input_tokens: + type: integer title: Input Tokens - type: integer output_tokens: + type: integer title: Output Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - input_tokens - output_tokens - total_tokens title: OpenAIResponseUsage - type: object + description: Usage information for OpenAI response. ResponseGuardrailSpec: description: Specification for a guardrail to apply during response generation. properties: @@ -3765,40 +3698,37 @@ components: title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseInputToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: + type: string title: Server Label - type: string server_url: - title: Server Url type: string + title: Server Url 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 + - type: string + const: always + - type: string + const: never - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter - default: never title: string | ApprovalFilter + default: never allowed_tools: anyOf: - items: @@ -3809,51 +3739,39 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label - server_url title: OpenAIResponseInputToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseObject: - description: Complete OpenAI response object containing generation results and metadata. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -3866,33 +3784,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -3902,20 +3827,9 @@ components: 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 @@ -3925,32 +3839,38 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + type: object required: - created_at - id @@ -3958,7 +3878,7 @@ components: - output - status title: OpenAIResponseObject - type: object + description: Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: @@ -5122,43 +5042,32 @@ components: title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: - description: Response object confirming deletion of an OpenAI response. properties: id: + type: string title: Id - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: OpenAIDeleteResponseObject - type: object + description: Response object confirming deletion of an OpenAI response. 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5171,39 +5080,48 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Data object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data title: ListOpenAIResponseInputItem - type: object + description: List container for OpenAI response input items. 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 + title: RunShieldResponse + description: Response from running a safety shield. SafetyViolation: - description: Details of a safety violation detected by content moderation. properties: violation_level: $ref: '#/components/schemas/ViolationLevel' @@ -5211,25 +5129,25 @@ components: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - title: Metadata type: object + title: Metadata + type: object required: - violation_level title: SafetyViolation - type: object + description: Details of a safety violation detected by content moderation. ViolationLevel: - description: Severity level of a safety violation. + type: string enum: - info - warn - error title: ViolationLevel - type: string + description: Severity level of a safety violation. AggregationFunctionType: - description: Types of aggregation functions for scoring results. + type: string enum: - average - weighted_average @@ -5237,193 +5155,176 @@ components: - categorical_count - accuracy title: AggregationFunctionType - type: string + description: Types of aggregation functions for scoring results. ArrayType: - description: Parameter type for array values. properties: type: + type: string const: array - default: array title: Type - type: string - title: ArrayType + default: array type: object + title: ArrayType + description: Parameter type for array values. BasicScoringFnParams: - description: Parameters for basic scoring function configuration. properties: type: - const: basic - default: basic - title: Type type: string + const: basic + title: Type + default: basic aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object title: BasicScoringFnParams - type: object + description: Parameters for basic scoring function configuration. BooleanType: - description: Parameter type for boolean values. properties: type: + type: string const: boolean + title: Type default: boolean - title: Type - type: string + type: object title: BooleanType - type: object + description: Parameter type for boolean values. ChatCompletionInputType: - description: Parameter type for chat completion input. properties: type: + type: string const: chat_completion_input + title: Type default: chat_completion_input - title: Type - type: string + type: object title: ChatCompletionInputType - type: object + description: Parameter type for chat completion input. CompletionInputType: - description: Parameter type for completion input. properties: type: + type: string const: completion_input + title: Type default: completion_input - title: Type - type: string + type: object title: CompletionInputType - type: object + description: Parameter type for completion input. JsonType: - description: Parameter type for JSON values. properties: type: + type: string const: json - default: json title: Type - type: string - title: JsonType + default: json type: object + title: JsonType + description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: - description: Parameters for LLM-as-judge scoring function configuration. properties: type: + type: string const: llm_as_judge - default: llm_as_judge title: Type - type: string + default: llm_as_judge judge_model: - title: Judge Model type: string + title: Judge Model 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 + title: Judge Score Regexes + description: Regexes to extract the answer from generated response aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object required: - judge_model title: LLMAsJudgeScoringFnParams - type: object + description: Parameters for LLM-as-judge scoring function configuration. NumberType: - description: Parameter type for numeric values. properties: type: + type: string const: number + title: Type default: number - title: Type - type: string + type: object title: NumberType - type: object + description: Parameter type for numeric values. ObjectType: - description: Parameter type for object values. properties: type: + type: string const: object - default: object title: Type - type: string - title: ObjectType + default: object type: object + title: ObjectType + description: Parameter type for object values. RegexParserScoringFnParams: - description: Parameters for regex parser scoring function configuration. properties: type: - const: regex_parser - default: regex_parser - title: Type type: string + const: regex_parser + title: Type + default: regex_parser parsing_regexes: - description: Regex to extract the answer from generated response items: type: string - title: Parsing Regexes type: array + title: Parsing Regexes + description: Regex to extract the answer from generated response 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 + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row type: object + title: RegexParserScoringFnParams + description: Parameters for regex parser scoring function configuration. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: scoring_function - default: scoring_function - title: Type type: string + const: scoring_function + title: Type + default: scoring_function description: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - description: Any additional metadata for this definition - title: Metadata type: object + title: Metadata + description: Any additional metadata for this definition 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 @@ -5444,32 +5345,45 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + description: The return type of the deterministic function + discriminator: + propertyName: type + 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' params: anyOf: - - discriminator: - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - propertyName: type - oneOf: + - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + type: object required: - identifier - provider_id - return_type title: ScoringFn - type: object + description: A scoring function resource for evaluating model outputs. ScoringFnParams: discriminator: mapping: @@ -5486,127 +5400,124 @@ components: title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams StringType: - description: Parameter type for string values. properties: type: + type: string const: string - default: string title: Type - type: string - title: StringType + default: string type: object + title: StringType + description: Parameter type for string values. UnionType: - description: Parameter type for union values. properties: type: - const: union - default: union - title: Type type: string - title: UnionType + const: union + title: Type + default: union type: object + title: UnionType + description: Parameter type for union values. ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' - title: Data type: array + title: Data + type: object required: - data title: ListScoringFunctionsResponse - type: object ScoreResponse: - description: The response from scoring. properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Results type: object + title: Results + type: object required: - results title: ScoreResponse - type: object + description: The response from scoring. ScoringResult: - description: A scoring result for a single row. properties: score_rows: items: additionalProperties: true type: object - title: Score Rows type: array + title: Score Rows aggregated_results: additionalProperties: true - title: Aggregated Results type: object + title: Aggregated Results + type: object required: - score_rows - aggregated_results title: ScoringResult - type: object + description: A scoring result for a single row. 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 + title: Results + type: object required: - results title: ScoreBatchResponse - type: object + description: Response from batch scoring operations on datasets. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: shield - default: shield - title: Type type: string + const: shield + title: Type + default: shield params: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true + type: object required: - identifier - provider_id title: Shield - type: object + description: A safety shield resource that can be used to check content. ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' - title: Data type: array + title: Data + type: object required: - data title: ListShieldsResponse - type: object ImageContentItem: description: A image content item properties: @@ -5663,184 +5574,172 @@ components: title: TextContentItem title: ImageContentItem | TextContentItem TextContentItem: - description: A text content item properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: TextContentItem - type: object + description: A text content item 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 + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Output | TextContentItem] - type: 'null' - title: string | list[ImageContentItem | TextContentItem] - nullable: true + title: string | list[ImageContentItem-Output | TextContentItem] 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 + title: ToolInvocationResult + description: Result of a tool invocation. URL: - description: A URL reference to external content. properties: uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URL - type: object + description: A URL reference to external content. ToolDef: - description: Tool definition used in runtime contexts. properties: toolgroup_id: anyOf: - type: string - type: 'null' - nullable: true name: - title: Name type: string + title: Name 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 + type: object required: - name title: ToolDef - type: object + description: Tool definition used in runtime contexts. ListToolDefsResponse: - description: Response containing a list of tool definitions. properties: data: items: $ref: '#/components/schemas/ToolDef' - title: Data type: array + title: Data + type: object required: - data title: ListToolDefsResponse - type: object + description: Response containing a list of tool definitions. ToolGroup: - description: A group of related tools managed together. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: tool_group - default: tool_group - title: Type type: string + const: tool_group + title: Type + default: tool_group 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 + type: object required: - identifier - provider_id title: ToolGroup - type: object + description: A group of related tools managed together. ListToolGroupsResponse: - description: Response containing a list of tool groups. properties: data: items: $ref: '#/components/schemas/ToolGroup' - title: Data type: array + title: Data + type: object required: - data title: ListToolGroupsResponse - type: object + description: Response containing a list of tool groups. Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -5900,105 +5799,94 @@ components: title: Chunk 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 + title: 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. QueryChunksResponse: - description: Response from querying chunks in a vector database. properties: chunks: items: - $ref: '#/components/schemas/Chunk' - title: Chunks + $ref: '#/components/schemas/Chunk-Output' type: array + title: Chunks scores: items: type: number - title: Scores type: array + title: Scores + type: object required: - chunks - scores title: QueryChunksResponse - type: object + description: Response from querying chunks in a vector database. VectorStoreFileCounts: - description: File processing status counts for a vector store. properties: completed: + type: integer title: Completed - type: integer cancelled: + type: integer title: Cancelled - type: integer failed: + type: integer title: Failed - type: integer in_progress: + type: integer title: In Progress - type: integer total: - title: Total type: integer + title: Total + type: object required: - completed - cancelled @@ -6006,91 +5894,85 @@ components: - in_progress - total title: VectorStoreFileCounts - type: object + description: File processing status counts for a vector store. VectorStoreListResponse: - description: Response from listing vector stores. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListResponse - type: object + description: Response from listing vector stores. VectorStoreObject: - description: OpenAI Vector Store object. properties: id: + type: string title: Id - type: string object: - default: vector_store - title: Object type: string + title: Object + default: vector_store created_at: - title: Created At type: integer + title: Created At name: anyOf: - type: string - type: 'null' - nullable: true usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: - default: completed - title: Status type: string + title: Status + default: completed 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 + title: Metadata + type: object required: - id - created_at - file_counts title: VectorStoreObject - type: object + description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: @@ -6104,159 +5986,151 @@ components: title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreChunkingStrategyAuto: - description: Automatic chunking strategy for vector store files. properties: type: + type: string const: auto - default: auto title: Type - type: string - title: VectorStoreChunkingStrategyAuto + default: auto type: object + title: VectorStoreChunkingStrategyAuto + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: - description: Static chunking strategy with configurable parameters. properties: type: - const: static - default: static - title: Type type: string + const: static + title: Type + default: static static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + type: object required: - static title: VectorStoreChunkingStrategyStatic - type: object + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: - description: Configuration for static chunking strategy. properties: chunk_overlap_tokens: - default: 400 + type: integer title: Chunk Overlap Tokens - type: integer + default: 400 max_chunk_size_tokens: - default: 800 - maximum: 4096 - minimum: 100 - title: Max Chunk Size Tokens type: integer - title: VectorStoreChunkingStrategyStaticConfig + maximum: 4096.0 + minimum: 100.0 + title: Max Chunk Size Tokens + default: 800 type: object + title: VectorStoreChunkingStrategyStaticConfig + description: Configuration for static chunking strategy. 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true - title: OpenAICreateVectorStoreRequestWithExtraBody + additionalProperties: true type: object + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. VectorStoreDeleteResponse: - description: Response from deleting a vector store. properties: id: + type: string title: Id - type: string object: - default: vector_store.deleted - title: Object type: string + title: Object + default: vector_store.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreDeleteResponse - type: object + description: Response from deleting a vector store. 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 + title: File Ids 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true + additionalProperties: true + type: object required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - type: object + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: - description: OpenAI Vector Store File Batch object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file_batch + type: string title: Object - type: string + default: vector_store.file_batch created_at: - title: Created At type: integer + title: Created At vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id status: title: Status type: string @@ -6268,6 +6142,7 @@ components: default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' + type: object required: - id - created_at @@ -6275,7 +6150,7 @@ components: - status - file_counts title: VectorStoreFileBatchObject - type: object + description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: type: string enum: @@ -6285,7 +6160,6 @@ components: - failed default: completed VectorStoreFileLastError: - description: Error information for failed vector store file processing. properties: code: title: Code @@ -6295,48 +6169,47 @@ components: - rate_limit_exceeded default: server_error message: - title: Message type: string + title: Message + type: object required: - code - message title: VectorStoreFileLastError - type: object + description: Error information for failed vector store file processing. VectorStoreFileObject: - description: OpenAI Vector Store File object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file - title: Object type: string + title: Object + default: vector_store.file attributes: additionalProperties: true - title: Attributes type: object + title: Attributes 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 + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' created_at: - title: Created At type: integer + title: Created At last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' - nullable: true title: VectorStoreFileLastError status: title: Status @@ -6348,12 +6221,13 @@ components: - failed default: completed usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id + type: object required: - id - chunking_strategy @@ -6361,158 +6235,149 @@ components: - status - vector_store_id title: VectorStoreFileObject - type: object + description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: - description: Response from listing files in a vector store file batch. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreFilesListInBatchResponse - type: object + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: - description: Response from listing files in a vector store. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListFilesResponse - type: object + description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: - description: Response from deleting a vector store file. properties: id: + type: string title: Id - type: string object: - default: vector_store.file.deleted - title: Object type: string + title: Object + default: vector_store.file.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreFileDeleteResponse - type: object + description: Response from deleting a vector store file. VectorStoreContent: - description: Content item from a vector store file or search result. properties: type: + type: string const: text title: Type - type: string text: - title: Text type: string + title: Text 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 + type: object required: - type - text title: VectorStoreContent - type: object + description: Content item from a vector store file or search result. 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 + const: vector_store.file_content.page + title: Object + default: vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data title: VectorStoreFileContentResponse - type: object + description: Represents the parsed content of a vector store file. VectorStoreSearchResponse: - description: Response from searching a vector store. properties: file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename score: - title: Score type: number + title: Score attributes: anyOf: - additionalProperties: @@ -6523,241 +6388,230 @@ components: title: string | number | boolean type: object - type: 'null' - nullable: true content: items: $ref: '#/components/schemas/VectorStoreContent' - title: Content type: array + title: Content + type: object required: - file_id - filename - score - content title: VectorStoreSearchResponse - type: object + description: Response from searching a vector store. VectorStoreSearchResponsePage: - description: Paginated response from searching a vector store. properties: object: - default: vector_store.search_results.page - title: Object type: string + title: Object + default: vector_store.search_results.page search_query: items: type: string - title: Search Query type: array + title: Search Query data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - search_query - data title: VectorStoreSearchResponsePage - type: object + description: Paginated response from searching a vector store. VersionInfo: - description: Version information for the service. properties: version: - title: Version type: string + title: Version + type: object required: - version title: VersionInfo - type: object + description: Version information for the service. PaginatedResponse: - description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More url: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data - has_more title: PaginatedResponse - type: object + description: A generic paginated response that follows a simple format. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: dataset - default: dataset - title: Type type: string + const: dataset + title: Type + default: dataset 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 + discriminator: + propertyName: type + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' metadata: additionalProperties: true - description: Any additional metadata for this dataset - title: Metadata type: object + title: Metadata + description: Any additional metadata for this dataset + type: object required: - identifier - provider_id - purpose - source title: Dataset - type: object + description: Dataset resource for storing and accessing training or evaluation data. RowsDataSource: - description: A dataset stored in rows. properties: type: - const: rows - default: rows - title: Type type: string + const: rows + title: Type + default: rows rows: items: additionalProperties: true type: object - title: Rows type: array + title: Rows + type: object required: - rows title: RowsDataSource - type: object + description: A dataset stored in rows. URIDataSource: - description: A dataset that can be obtained from a URI. properties: type: + type: string const: uri - default: uri title: Type - type: string + default: uri uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URIDataSource - type: object + description: A dataset that can be obtained from a URI. ListDatasetsResponse: - description: Response from listing datasets. properties: data: items: $ref: '#/components/schemas/Dataset' - title: Data type: array + title: Data + type: object required: - data title: ListDatasetsResponse - type: object + description: Response from listing datasets. Benchmark: - description: A benchmark resource for evaluating model performance. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: + type: string const: benchmark - default: benchmark title: Type - type: string + default: benchmark dataset_id: - title: Dataset Id type: string + title: Dataset Id scoring_functions: items: type: string - title: Scoring Functions type: array + title: Scoring Functions metadata: additionalProperties: true - description: Metadata for this evaluation task - title: Metadata type: object + title: Metadata + description: Metadata for this evaluation task + type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark - type: object + description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' - title: Data type: array + title: Data + type: object required: - data title: ListBenchmarksResponse - 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 @@ -6765,41 +6619,46 @@ components: title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + title: Scoring Params + description: Map between scoring function id and parameters for each scoring function you want to run 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 + type: object required: - eval_candidate title: BenchmarkConfig - type: object + description: A benchmark configuration for evaluation. GreedySamplingStrategy: - description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: + type: string const: greedy - default: greedy title: Type - type: string - title: GreedySamplingStrategy + default: greedy type: object + title: GreedySamplingStrategy + description: Greedy sampling strategy that selects the highest probability token at each step. ModelCandidate: - description: A model candidate for evaluation. properties: type: + type: string const: model - default: model title: Type - type: string + default: model model: - title: Model type: string + title: Model sampling_params: $ref: '#/components/schemas/SamplingParams' system_message: @@ -6807,23 +6666,16 @@ components: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' - nullable: true title: SystemMessage + type: object required: - model - sampling_params title: ModelCandidate - type: object + description: A model candidate for evaluation. 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 @@ -6832,11 +6684,16 @@ components: - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + discriminator: + propertyName: type + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' max_tokens: anyOf: - type: integer - type: 'null' - nullable: true repetition_penalty: anyOf: - type: number @@ -6848,74 +6705,73 @@ components: type: string type: array - type: 'null' - nullable: true - title: SamplingParams type: object + title: SamplingParams + description: Sampling parameters. SystemMessage: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string - - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type - oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] - title: string | list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + type: object required: - content title: SystemMessage - type: object + description: A system message providing instructions or context to the model. 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 + const: top_k + title: Type + default: top_k top_k: - minimum: 1 - title: Top K type: integer + minimum: 1.0 + title: Top K + type: object required: - top_k title: TopKSamplingStrategy - type: object + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. 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 + const: top_p + title: Type + default: top_p temperature: anyOf: - type: number @@ -6926,94 +6782,94 @@ components: - type: number - type: 'null' default: 0.95 + type: object required: - temperature title: TopPSamplingStrategy - type: object + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. EvaluateResponse: - description: The response from an evaluation. properties: generations: items: additionalProperties: true type: object - title: Generations type: array + title: Generations scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Scores type: object + title: Scores + type: object required: - generations - scores title: EvaluateResponse - type: object + description: The response from an evaluation. Job: - description: A job execution instance with status tracking. properties: job_id: - title: Job Id type: string + title: Job Id status: $ref: '#/components/schemas/JobStatus' + type: object required: - job_id - status title: Job - type: object + description: A job execution instance with status tracking. RerankData: - description: A single rerank result from a reranking response. properties: index: - title: Index type: integer + title: Index relevance_score: - title: Relevance Score type: number + title: Relevance Score + type: object required: - index - relevance_score title: RerankData - type: object + description: A single rerank result from a reranking response. RerankResponse: - description: Response from a reranking request. properties: data: items: $ref: '#/components/schemas/RerankData' - title: Data type: array + title: Data + type: object required: - data title: RerankResponse - type: object + description: Response from a reranking request. Checkpoint: - description: Checkpoint created during training runs. properties: identifier: - title: Identifier type: string + title: Identifier created_at: + type: string format: date-time title: Created At - type: string epoch: - title: Epoch type: integer + title: Epoch post_training_job_id: + type: string title: Post Training Job Id - type: string path: - title: Path type: string + title: Path training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' - nullable: true title: PostTrainingMetric + type: object required: - identifier - created_at @@ -7021,137 +6877,131 @@ components: - post_training_job_id - path title: Checkpoint - type: object + description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: - description: Artifacts of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid checkpoints: items: $ref: '#/components/schemas/Checkpoint' - title: Checkpoints type: array + title: Checkpoints + type: object required: - job_uuid title: PostTrainingJobArtifactsResponse - type: object + description: Artifacts of a finetuning job. PostTrainingMetric: - description: Training metrics captured during post-training jobs. properties: epoch: - title: Epoch type: integer + title: Epoch train_loss: + type: number title: Train Loss - type: number validation_loss: + type: number title: Validation Loss - type: number perplexity: - title: Perplexity type: number + title: Perplexity + type: object required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric - type: object + description: Training metrics captured during post-training jobs. PostTrainingJobStatusResponse: - description: Status of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true started_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true completed_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - 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 + title: Checkpoints + type: object required: - job_uuid - status title: PostTrainingJobStatusResponse - type: object + description: Status of a finetuning job. ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' - title: Data type: array + title: Data + type: object required: - data title: ListPostTrainingJobsResponse - type: object DPOAlignmentConfig: - description: Configuration for Direct Preference Optimization (DPO) alignment. properties: beta: - title: Beta type: number + title: Beta loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid + type: object required: - beta title: DPOAlignmentConfig - type: object + description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: + type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType - type: string DataConfig: - description: Configuration for training data and data loading. properties: dataset_id: - title: Dataset Id type: string + title: Dataset Id batch_size: - title: Batch Size type: integer + title: Batch Size shuffle: - title: Shuffle type: boolean + title: Shuffle data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' - nullable: true packed: anyOf: - type: boolean @@ -7162,22 +7012,22 @@ components: - type: boolean - type: 'null' default: false + type: object required: - dataset_id - batch_size - shuffle - data_format title: DataConfig - type: object + description: Configuration for training data and data loading. DatasetFormat: - description: Format of the training dataset. + type: string enum: - instruct - dialog title: DatasetFormat - type: string + description: Format of the training dataset. EfficiencyConfig: - description: Configuration for memory and compute efficiency optimizations. properties: enable_activation_checkpointing: anyOf: @@ -7199,51 +7049,51 @@ components: - type: boolean - type: 'null' default: false - title: EfficiencyConfig type: object + title: EfficiencyConfig + description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: - description: Configuration parameters for the optimization algorithm. properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: + type: number title: Lr - type: number weight_decay: - title: Weight Decay type: number + title: Weight Decay num_warmup_steps: - title: Num Warmup Steps type: integer + title: Num Warmup Steps + type: object required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig - type: object + description: Configuration parameters for the optimization algorithm. OptimizerType: - description: Available optimizer algorithms for training. + type: string enum: - adam - adamw - sgd title: OptimizerType - type: string + description: Available optimizer algorithms for training. TrainingConfig: - description: Comprehensive configuration for the training process. properties: n_epochs: + type: integer title: N Epochs - type: integer max_steps_per_epoch: - default: 1 + type: integer title: Max Steps Per Epoch - type: integer - gradient_accumulation_steps: default: 1 - title: Gradient Accumulation Steps + gradient_accumulation_steps: type: integer + title: Gradient Accumulation Steps + default: 1 max_validation_steps: anyOf: - type: integer @@ -7254,40 +7104,38 @@ components: - $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 + type: object required: - n_epochs title: TrainingConfig - type: object + description: Comprehensive configuration for the training process. PostTrainingJob: properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid + type: object required: - job_uuid title: PostTrainingJob - type: object AlgorithmConfig: discriminator: mapping: @@ -7301,30 +7149,29 @@ components: title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig LoraFinetuningConfig: - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. properties: type: - const: LoRA - default: LoRA - title: Type type: string + const: LoRA + title: Type + default: LoRA lora_attn_modules: items: type: string - title: Lora Attn Modules type: array + title: Lora Attn Modules apply_lora_to_mlp: + type: boolean title: Apply Lora To Mlp - type: boolean apply_lora_to_output: - title: Apply Lora To Output type: boolean + title: Apply Lora To Output rank: + type: integer title: Rank - type: integer alpha: - title: Alpha type: integer + title: Alpha use_dora: anyOf: - type: boolean @@ -7335,6 +7182,7 @@ components: - type: boolean - type: 'null' default: false + type: object required: - lora_attn_modules - apply_lora_to_mlp @@ -7342,26 +7190,26 @@ components: - rank - alpha title: LoraFinetuningConfig - type: object + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. properties: type: + type: string const: QAT - default: QAT title: Type - type: string + default: QAT quantizer_name: - title: Quantizer Name type: string + title: Quantizer Name group_size: - title: Group Size type: integer + title: Group Size + type: object required: - quantizer_name - group_size title: QATFinetuningConfig - type: object + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. ParamType: discriminator: mapping: @@ -7407,24 +7255,1600 @@ components: - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource + AllowedToolsFilter: + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can be used. + ApprovalFilter: + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. + BatchError: + properties: + code: + anyOf: + - type: string + - type: 'null' + line: + anyOf: + - type: integer + - type: 'null' + message: + anyOf: + - type: string + - type: 'null' + param: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: BatchError + BatchRequestCounts: + properties: + completed: + type: integer + title: Completed + failed: + type: integer + title: Failed + total: + type: integer + title: Total + additionalProperties: true + type: object + required: + - completed + - failed + - total + title: BatchRequestCounts + BatchUsage: + properties: + input_tokens: + type: integer + title: Input Tokens + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + type: integer + title: Output Tokens + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + type: integer + title: Total Tokens + additionalProperties: true + type: object + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + BatchesPostRequest: + properties: + input_file_id: + type: string + title: Input File Id + endpoint: + type: string + title: Endpoint + completion_window: + type: string + const: 24h + title: Completion Window + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + idempotency_key: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_file_id + - endpoint + - completion_window + title: BatchesPostRequest + Body_openai_upload_file_v1_files_post: + properties: + file: + type: string + format: binary + title: File + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + expires_after: + anyOf: + - $ref: '#/components/schemas/ExpiresAfter' + title: ExpiresAfter + - type: 'null' + title: ExpiresAfter + type: object + required: + - file + - purpose + title: Body_openai_upload_file_v1_files_post + Body_register_benchmark_v1alpha_eval_benchmarks_post: + properties: + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - scoring_functions + title: Body_register_benchmark_v1alpha_eval_benchmarks_post + Body_register_scoring_function_v1_scoring_functions_post: + properties: + return_type: + anyOf: + - $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: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: Params + type: object + required: + - return_type + title: Body_register_scoring_function_v1_scoring_functions_post + Body_register_tool_group_v1_toolgroups_post: + properties: + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: Body_register_tool_group_v1_toolgroups_post + Chunk-Input: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + Chunk-Output: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + type: array + title: list[ImageContentItem-Output | TextContentItem] + title: string | list[ImageContentItem-Output | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + ConversationItemInclude: + type: string + enum: + - web_search_call.action.sources + - code_interpreter_call.outputs + - computer_call_output.output.image_url + - file_search_call.results + - message.input_image.image_url + - message.output_text.logprobs + - reasoning.encrypted_content + title: ConversationItemInclude + description: Specify additional output data to include in the model response. + ConversationsByConversationIdItemsPostRequest: + properties: + items: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + title: Items + type: object + required: + - items + title: ConversationsByConversationIdItemsPostRequest + ConversationsByConversationIdPostRequest: + properties: + metadata: + additionalProperties: + type: string + type: object + title: Metadata + type: object + required: + - metadata + title: ConversationsByConversationIdPostRequest + ConversationsPostRequest: + properties: + items: + anyOf: + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + - type: 'null' + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + type: object + title: ConversationsPostRequest + DatasetPurpose: + type: string + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + description: Purpose of the dataset. Each purpose has a required input data schema. + Errors: + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + object: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: Errors + HealthStatus: + type: string + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + ImageContentItem-Input: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + ImageContentItem-Output: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + InputTokensDetails: + properties: + cached_tokens: + type: integer + title: Cached Tokens + additionalProperties: true + type: object + required: + - cached_tokens + title: InputTokensDetails + JobStatus: + type: string + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + description: Status of a job execution. + MCPListToolsTool: + properties: + input_schema: + additionalProperties: true + type: object + title: Input Schema + name: + type: string + title: Name + description: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_schema + - name + title: MCPListToolsTool + description: Tool definition returned by MCP list tools operation. + ModelsPostRequest: + properties: + model_id: + type: string + title: Model Id + provider_model_id: + anyOf: + - type: string + - type: 'null' + provider_id: + anyOf: + - type: string + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + model_type: + anyOf: + - $ref: '#/components/schemas/ModelType' + title: ModelType + - type: 'null' + title: ModelType + type: object + required: + - model_id + title: ModelsPostRequest + ModerationsPostRequest: + properties: + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + model: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input + title: ModerationsPostRequest + OpenAIAssistantMessageParam-Input: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIAssistantMessageParam-Output: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIChatCompletionUsageCompletionTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. + OpenAIChatCompletionUsagePromptTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. + OpenAIResponseMessage-Input: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseMessage-Output: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseOutputMessageFileSearchToolCallResults: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + file_id: + type: string + title: File Id + filename: + type: string + title: Filename + score: + type: number + title: Score + text: + type: string + title: Text + type: object + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + OpenAIResponseTextFormat: + 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' + type: object + title: OpenAIResponseTextFormat + description: Configuration for Responses API text format. + OpenAIResponseUsageInputTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageInputTokensDetails + description: Token details for input tokens in OpenAI response usage. + OpenAIResponseUsageOutputTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageOutputTokensDetails + description: Token details for output tokens in OpenAI response usage. + OpenAIUserMessageParam-Input: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OpenAIUserMessageParam-Output: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OutputTokensDetails: + properties: + reasoning_tokens: + type: integer + title: Reasoning Tokens + additionalProperties: true + type: object + required: + - reasoning_tokens + title: OutputTokensDetails + PromptsByPromptIdPostRequest: + properties: + prompt: + type: string + title: Prompt + version: + type: integer + title: Version + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + set_as_default: + type: boolean + title: Set As Default + default: true + type: object + required: + - prompt + - version + title: PromptsByPromptIdPostRequest + PromptsByPromptIdSetDefaultVersionPostRequest: + properties: + version: + type: integer + title: Version + type: object + required: + - version + title: PromptsByPromptIdSetDefaultVersionPostRequest + PromptsPostRequest: + properties: + prompt: + type: string + title: Prompt + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + required: + - prompt + title: PromptsPostRequest + ResponsesPostRequest: + properties: + input: + anyOf: + - type: string + - items: + anyOf: + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input + type: array + title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + model: + type: string + title: Model + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + title: OpenAIResponsePrompt + instructions: + anyOf: + - type: string + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + conversation: + anyOf: + - type: string + - type: 'null' + store: + anyOf: + - type: boolean + - type: 'null' + default: true + stream: + anyOf: + - type: boolean + - type: 'null' + default: false + temperature: + anyOf: + - type: number + - type: 'null' + text: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseText' + title: OpenAIResponseText + - type: 'null' + title: OpenAIResponseText + tools: + anyOf: + - items: + 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 + discriminator: + propertyName: type + 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' + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + include: + anyOf: + - items: + type: string + type: array + - type: 'null' + max_infer_iters: + anyOf: + - type: integer + - type: 'null' + default: 10 + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - input + - model + title: ResponsesPostRequest + SafetyRunShieldPostRequest: + properties: + shield_id: + type: string + title: Shield Id + messages: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array + title: Messages + params: + additionalProperties: true + type: object + title: Params + type: object + required: + - shield_id + - messages + - params + title: SafetyRunShieldPostRequest + ScoringScoreBatchPostRequest: + properties: + dataset_id: + type: string + title: Dataset Id + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + save_results_dataset: + type: boolean + title: Save Results Dataset + default: false + type: object + required: + - dataset_id + - scoring_functions + title: ScoringScoreBatchPostRequest + ScoringScorePostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + type: object + required: + - input_rows + - scoring_functions + title: ScoringScorePostRequest + SearchRankingOptions: + properties: + ranker: + anyOf: + - type: string + - type: 'null' + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + type: object + title: SearchRankingOptions + description: Options for ranking and filtering search results. + ShieldsPostRequest: + properties: + shield_id: + type: string + title: Shield Id + provider_shield_id: + anyOf: + - type: string + - type: 'null' + provider_id: + anyOf: + - type: string + - type: 'null' + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - shield_id + title: ShieldsPostRequest + ToolRuntimeInvokePostRequest: + properties: + tool_name: + type: string + title: Tool Name + kwargs: + additionalProperties: true + type: object + title: Kwargs + authorization: + anyOf: + - type: string + - type: 'null' + type: object + required: + - tool_name + - kwargs + title: ToolRuntimeInvokePostRequest + V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + benchmark_config: + $ref: '#/components/schemas/BenchmarkConfig' + type: object + required: + - input_rows + - scoring_functions + - benchmark_config + title: V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest + V1AlphaInferenceRerankPostRequest: + properties: + model: + type: string + title: Model + query: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + items: + items: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + type: array + title: Items + max_num_results: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - model + - query + - items + title: V1AlphaInferenceRerankPostRequest + V1AlphaPostTrainingPreferenceOptimizePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + finetuned_model: + type: string + title: Finetuned Model + algorithm_config: + $ref: '#/components/schemas/DPOAlignmentConfig' + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + type: object + required: + - job_uuid + - finetuned_model + - algorithm_config + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingPreferenceOptimizePostRequest + V1AlphaPostTrainingSupervisedFineTunePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + model: + anyOf: + - type: string + - type: 'null' + description: Model descriptor for training if not in provider config` + checkpoint_dir: + anyOf: + - type: string + - type: 'null' + algorithm_config: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LoraFinetuningConfig' + title: LoraFinetuningConfig + - $ref: '#/components/schemas/QATFinetuningConfig' + title: QATFinetuningConfig + discriminator: + propertyName: type + mapping: + LoRA: '#/components/schemas/LoraFinetuningConfig' + QAT: '#/components/schemas/QATFinetuningConfig' + title: LoraFinetuningConfig | QATFinetuningConfig + - type: 'null' + title: Algorithm Config + type: object + required: + - job_uuid + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingSupervisedFineTunePostRequest + V1BetaDatasetsPostRequestLoose: + properties: + purpose: + title: Purpose + source: + title: Source + metadata: + title: Metadata + dataset_id: + title: Dataset Id + type: object + required: + - purpose + - source + title: V1BetaDatasetsPostRequestLoose + VectorIoQueryPostRequest: + properties: + vector_store_id: + type: string + title: Vector Store Id + query: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - vector_store_id + - query + title: VectorIoQueryPostRequest + VectorStoresByVectorStoreIdFilesByFileIdPostRequest: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + type: object + required: + - attributes + title: VectorStoresByVectorStoreIdFilesByFileIdPostRequest + VectorStoresByVectorStoreIdFilesPostRequest: + properties: + file_id: + type: string + title: File Id + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + chunking_strategy: + anyOf: + - oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + type: object + required: + - file_id + title: VectorStoresByVectorStoreIdFilesPostRequest + VectorStoresByVectorStoreIdPostRequest: + properties: + name: + anyOf: + - type: string + - type: 'null' + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: VectorStoresByVectorStoreIdPostRequest + VectorStoresByVectorStoreIdSearchPostRequest: + 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' + max_num_results: + anyOf: + - type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + title: SearchRankingOptions + rewrite_query: + anyOf: + - type: boolean + - type: 'null' + default: false + search_mode: + anyOf: + - type: string + - type: 'null' + default: vector + type: object + required: + - query + title: VectorStoresByVectorStoreIdSearchPostRequest _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 + title: _URLOrData + description: A URL or a base64 encoded string SamplingStrategy: discriminator: mapping: @@ -7484,99 +8908,6 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat - 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 - 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 - 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 - 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 OpenAIResponseContentPart: discriminator: mapping: @@ -7592,56 +8923,6 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText - 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 - 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 SpanEndPayload: description: Payload for a span end event. properties: @@ -7863,110 +9144,6 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - 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 ImageDelta: description: An image content delta for streaming responses. properties: @@ -7998,16 +9175,6 @@ components: - text title: TextDelta type: object - JobStatus: - description: Status of a job execution. - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - type: string MetricInResponse: description: A metric value included in API responses. properties: @@ -8123,14 +9290,6 @@ components: - 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 Api: description: Enumeration of all available APIs in the Llama Stack system. enum: @@ -8459,26 +9618,6 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig 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 OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -8649,13 +9788,6 @@ components: - content title: UserMessage type: object - HealthStatus: - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - type: string PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -8836,3 +9968,131 @@ components: - query title: VectorStoreSearchRequest type: object + 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' +tags: +- description: APIs for creating and interacting with agentic systems. + name: Agents + x-displayName: Agents +- description: |- + The API is designed to allow use of openai client libraries for seamless integration. + + This API provides the following extensions: + - idempotent batch creation + + Note: This API is currently under active development and may undergo changes. + name: Batches + x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale. +- description: '' + name: Benchmarks +- description: Protocol for conversation management operations. + name: Conversations + x-displayName: Conversations +- description: '' + name: DatasetIO +- description: '' + name: Datasets +- description: Llama Stack Evaluation API for running evaluations on model and agent candidates. + name: Eval + x-displayName: Evaluations +- description: This API is used to upload documents that can be used with other Llama Stack APIs. + name: Files + x-displayName: Files +- description: |- + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Three kinds of models are supported: + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. + - Rerank models: these models reorder the documents based on their relevance to a query. + name: Inference + x-displayName: Inference +- description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers. + name: Inspect + x-displayName: Inspect +- description: '' + name: Models +- description: '' + name: PostTraining (Coming Soon) +- description: Protocol for prompt management operations. + name: Prompts + x-displayName: Prompts +- description: Providers API for inspecting, listing, and modifying providers and their configurations. + name: Providers + x-displayName: Providers +- description: OpenAI-compatible Moderations API. + name: Safety + x-displayName: Safety +- description: '' + name: Scoring +- description: '' + name: ScoringFunctions +- description: '' + name: Shields +- description: '' + name: ToolGroups +- description: '' + name: ToolRuntime +- description: '' + name: VectorIO +x-tagGroups: +- name: Operations + tags: + - Agents + - Batches + - Benchmarks + - Conversations + - DatasetIO + - Datasets + - Eval + - Files + - Inference + - Inspect + - Models + - PostTraining (Coming Soon) + - Prompts + - Providers + - Safety + - Scoring + - ScoringFunctions + - Shields + - ToolGroups + - ToolRuntime + - VectorIO +security: +- Default: [] diff --git a/docs/static/experimental-llama-stack-spec.yaml b/docs/static/experimental-llama-stack-spec.yaml index f1aae937f..e3ae3f611 100644 --- a/docs/static/experimental-llama-stack-spec.yaml +++ b/docs/static/experimental-llama-stack-spec.yaml @@ -15,10 +15,6 @@ servers: paths: /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 @@ -37,6 +33,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Datasetio + summary: Append Rows + description: Append rows to a dataset. + operationId: append_rows_v1beta_datasetio_append_rows__dataset_id__post parameters: - name: dataset_id in: path @@ -44,31 +45,68 @@ paths: schema: type: string description: 'Path parameter: dataset_id' + requestBody: + content: + application/json: + schema: + items: + additionalProperties: true + type: object + type: array + title: Rows + required: true /v1beta/datasetio/iterrows/{dataset_id}: get: + responses: + '200': + description: A PaginatedResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Datasetio summary: Iterrows + description: |- + Get a paginated list of rows from a dataset. + + Uses offset-based pagination where: + - start_index: The starting index (0-based). If None, starts from beginning. + - limit: Number of items to return. If None or -1, returns all items. + + The response includes: + - data: List of items for the current page. + - has_more: Whether there are more items available after this set. 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: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: start_index + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Start Index - name: dataset_id in: path required: true @@ -77,16 +115,39 @@ paths: description: 'Path parameter: dataset_id' /v1beta/datasets: get: + responses: + '200': + description: A ListDatasetsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListDatasetsResponse' + '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' tags: - Datasets summary: List Datasets + description: List all datasets. operationId: list_datasets_v1beta_datasets_get + /v1beta/datasets/{dataset_id}: + get: responses: '200': - description: Successful Response + description: A Dataset. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Dataset' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -99,30 +160,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1beta/datasets/{dataset_id}: - get: tags: - Datasets summary: Get Dataset + description: Get a dataset by its ID. 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 @@ -132,16 +174,39 @@ paths: description: 'Path parameter: dataset_id' /v1alpha/eval/benchmarks: get: + responses: + '200': + description: A ListBenchmarksResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBenchmarksResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Benchmarks summary: List Benchmarks + description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get + /v1alpha/eval/benchmarks/{benchmark_id}: + get: responses: '200': - description: Successful Response + description: A Benchmark. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Benchmark' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -154,30 +219,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/eval/benchmarks/{benchmark_id}: - get: tags: - Benchmarks summary: Get Benchmark + description: Get a benchmark by its ID. 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 @@ -187,16 +233,52 @@ paths: description: 'Path parameter: benchmark_id' /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: post: + responses: + '200': + description: EvaluateResponse object containing generations and scores. + content: + application/json: + schema: + $ref: '#/components/schemas/EvaluateResponse' + '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' tags: - Eval summary: Evaluate Rows + description: Evaluate a list of rows on a benchmark. operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post + parameters: + - name: benchmark_id + in: path + required: true + schema: + type: string + description: 'Path parameter: benchmark_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest' + required: true + /v1alpha/eval/benchmarks/{benchmark_id}/jobs: + post: responses: '200': - description: Successful Response + description: The job that was created to run the evaluation. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Job' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -209,37 +291,11 @@ paths: 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: - post: tags: - Eval summary: Run Eval + description: Run an evaluation on a benchmark. 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 @@ -247,18 +303,21 @@ paths: schema: type: string description: 'Path parameter: benchmark_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BenchmarkConfig' + required: true /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 + description: The status of the evaluation job. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Job' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -271,6 +330,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Status + description: Get the status of a job. + operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get parameters: - name: benchmark_id in: path @@ -285,10 +349,6 @@ paths: 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 @@ -307,6 +367,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Cancel + description: Cancel a job. + operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete parameters: - name: benchmark_id in: path @@ -322,16 +387,13 @@ paths: 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 + description: The result of the job. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/EvaluateResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -344,6 +406,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Result + description: Get the result of a job. + operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get parameters: - name: benchmark_id in: path @@ -359,34 +426,71 @@ paths: description: 'Path parameter: job_id' /v1alpha/inference/rerank: post: + responses: + '200': + description: RerankResponse with indices sorted by relevance score (descending). + content: + application/json: + schema: + $ref: '#/components/schemas/RerankResponse' + '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' tags: - Inference summary: Rerank + description: Rerank a list of documents based on their relevance to a query. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaInferenceRerankPostRequest' + required: true /v1alpha/post-training/job/artifacts: get: + responses: + '200': + description: A PostTrainingJobArtifactsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Post Training summary: Get Training Job Artifacts + description: Get the artifacts of a training job. operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid + /v1alpha/post-training/job/cancel: + post: responses: '200': description: Successful Response @@ -394,53 +498,71 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/job/cancel: - post: + description: Default Response tags: - Post Training summary: Cancel Training Job + description: Cancel a 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' + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid /v1alpha/post-training/job/status: get: + responses: + '200': + description: A PostTrainingJobStatusResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PostTrainingJobStatusResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Post Training summary: Get Training Job Status + description: Get the status of a training job. operationId: get_training_job_status_v1alpha_post_training_job_status_get + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid + /v1alpha/post-training/jobs: + get: responses: '200': - description: Successful Response + description: A ListPostTrainingJobsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPostTrainingJobsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -453,18 +575,20 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/jobs: - get: tags: - Post Training summary: Get Training Jobs + description: Get all training jobs. operationId: get_training_jobs_v1alpha_post_training_jobs_get + /v1alpha/post-training/preference-optimize: + post: responses: '200': - description: Successful Response + description: A PostTrainingJob. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/PostTrainingJob' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -477,18 +601,26 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/preference-optimize: - post: tags: - Post Training summary: Preference Optimize + description: Run preference optimization of a model. operationId: preference_optimize_v1alpha_post_training_preference_optimize_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaPostTrainingPreferenceOptimizePostRequest' + required: true + /v1alpha/post-training/supervised-fine-tune: + post: responses: '200': - description: Successful Response + description: A PostTrainingJob. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/PostTrainingJob' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -501,68 +633,18 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/supervised-fine-tune: - post: tags: - Post Training summary: Supervised Fine Tune + description: Run supervised fine-tuning of a model. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaPostTrainingSupervisedFineTunePostRequest' + required: true 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: Error: description: Error response from the API. Roughly follows RFC 7807. @@ -588,63 +670,61 @@ components: title: Error type: object ListBatchesResponse: - description: Response containing a list of batch objects. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: - description: List of batch objects items: $ref: '#/components/schemas/Batch' - title: Data type: array + title: Data + description: List of batch objects 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 + title: Has More + description: Whether there are more batches available + default: false + type: object required: - data title: ListBatchesResponse - type: object + description: Response containing a list of batch objects. Batch: - additionalProperties: true properties: id: + type: string title: Id - type: string completion_window: + type: string title: Completion Window - type: string created_at: - title: Created At type: integer + title: Created At endpoint: + type: string title: Endpoint - type: string input_file_id: - title: Input File Id type: string + title: Input File Id object: + type: string const: batch title: Object - type: string status: + type: string enum: - validating - failed @@ -655,90 +735,76 @@ components: - 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 + additionalProperties: true + type: object required: - id - completion_window @@ -748,36 +814,35 @@ components: - object - status title: Batch - type: object ListOpenAIChatCompletionResponse: - description: Response from listing OpenAI-compatible chat completions. properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse - type: object + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: @@ -811,19 +876,19 @@ components: title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionContentPartImageParam: - description: Image content part for OpenAI-compatible chat completion messages. properties: type: - const: image_url - default: image_url - title: Type type: string + const: image_url + title: Type + default: image_url image_url: $ref: '#/components/schemas/OpenAIImageURL' + type: object required: - image_url title: OpenAIChatCompletionContentPartImageParam - type: object + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -840,139 +905,130 @@ components: title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIChatCompletionContentPartTextParam: - description: Text content part for OpenAI-compatible chat completion messages. properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: OpenAIChatCompletionContentPartTextParam - type: object + description: Text content part for OpenAI-compatible chat completion messages. 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 + const: function + title: Type + default: function function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' - nullable: true title: OpenAIChatCompletionToolCallFunction - title: OpenAIChatCompletionToolCall type: object + title: OpenAIChatCompletionToolCall + description: Tool call specification for OpenAI-compatible chat completion responses. 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 + title: OpenAIChatCompletionToolCallFunction + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: - description: Usage information for OpenAI chat completion. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer completion_tokens: + type: integer title: Completion Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage - type: object + description: Usage information for OpenAI chat completion. 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + title: OpenAIUserMessageParam-Output | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' finish_reason: - title: Finish Reason type: string + title: Finish Reason index: - title: Index type: integer + title: Index logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' - nullable: true title: OpenAIChoiceLogprobs + type: object required: - message - finish_reason - index title: OpenAIChoice - type: object + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. properties: content: anyOf: @@ -980,24 +1036,22 @@ components: $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 + title: OpenAIChoiceLogprobs + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: - description: A message from the developer in an OpenAI-compatible chat completion request. properties: role: - const: developer - default: developer - title: Role type: string + const: developer + title: Role + default: developer content: anyOf: - type: string @@ -1010,58 +1064,54 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAIDeveloperMessageParam - type: object + description: A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: properties: type: - const: file - default: file - title: Type type: string + const: file + title: Type + default: file file: $ref: '#/components/schemas/OpenAIFileFile' + type: object 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 + title: OpenAIFileFile OpenAIImageURL: - description: Image URL specification for OpenAI-compatible chat completion messages. properties: url: - title: Url type: string + title: Url detail: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - url title: OpenAIImageURL - type: object + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: discriminator: mapping: @@ -1084,13 +1134,12 @@ components: title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAISystemMessageParam: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string @@ -1103,12 +1152,36 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAISystemMessageParam - type: object + description: A system message providing instructions or context to the model. OpenAITokenLogProb: + properties: + token: + type: string + title: Token + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + logprob: + type: number + title: Logprob + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + type: array + title: Top Logprobs + type: object + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb description: |- The log probability for a token from an OpenAI-compatible chat completion response. @@ -1116,42 +1189,16 @@ components: :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 OpenAIToolMessageParam: - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. properties: role: + type: string const: tool - default: tool title: Role - type: string + default: tool tool_call_id: - title: Tool Call Id type: string + title: Tool Call Id content: anyOf: - type: string @@ -1160,37 +1207,37 @@ components: type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] + type: object required: - tool_call_id - content title: OpenAIToolMessageParam - type: object + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. 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 + title: Token bytes: anyOf: - items: type: integer type: array - type: 'null' - nullable: true logprob: - title: Logprob type: number + title: Logprob + type: object required: - token - logprob title: OpenAITopLogProb - type: object + 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 OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -1230,11 +1277,10 @@ components: title: OpenAIUserMessageParam type: object OpenAIJSONSchema: - description: JSON schema specification for OpenAI-compatible structured response format. properties: name: - title: Name type: string + title: Name description: anyOf: - type: string @@ -1248,32 +1294,33 @@ components: - additionalProperties: true type: object - type: 'null' + type: object title: OpenAIJSONSchema - type: object + description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: - description: JSON object response format for OpenAI-compatible chat completion requests. properties: type: + type: string const: json_object - default: json_object title: Type - type: string - title: OpenAIResponseFormatJSONObject + default: json_object type: object + title: OpenAIResponseFormatJSONObject + description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: - description: JSON schema response format for OpenAI-compatible chat completion requests. properties: type: - const: json_schema - default: json_schema - title: Type type: string + const: json_schema + title: Type + default: json_schema json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' + type: object required: - json_schema title: OpenAIResponseFormatJSONSchema - type: object + description: JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: discriminator: mapping: @@ -1290,52 +1337,49 @@ components: title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject OpenAIResponseFormatText: - description: Text response format for OpenAI-compatible chat completion requests. properties: type: - const: text - default: text - title: Type type: string - title: OpenAIResponseFormatText + const: text + title: Type + default: text type: object + title: OpenAIResponseFormatText + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible chat completion endpoint. properties: model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array minItems: 1 title: Messages - type: array frequency_penalty: anyOf: - type: number - type: 'null' - nullable: true function_call: anyOf: - type: string @@ -1343,7 +1387,6 @@ components: type: object - type: 'null' title: string | object - nullable: true functions: anyOf: - items: @@ -1351,68 +1394,58 @@ components: 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: + - oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject + discriminator: + propertyName: type + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format - nullable: true seed: anyOf: - type: integer - type: 'null' - nullable: true stop: anyOf: - type: string @@ -1422,23 +1455,19 @@ components: 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 @@ -1446,7 +1475,6 @@ components: type: object - type: 'null' title: string | object - nullable: true tools: anyOf: - items: @@ -1454,63 +1482,60 @@ components: 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 + additionalProperties: true + type: object required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: - description: Response from an OpenAI-compatible chat completion request. properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' - nullable: true title: OpenAIChatCompletionUsage + type: object required: - id - choices - created - model title: OpenAIChatCompletion - type: object + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: @@ -1606,55 +1631,55 @@ components: OpenAICompletionWithInputMessages: properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Input Messages + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output | ... (5 variants) type: array + title: Input Messages + type: object required: - id - choices @@ -1662,14 +1687,11 @@ components: - model - input_messages title: OpenAICompletionWithInputMessages - type: object OpenAICompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible completion endpoint. properties: model: - title: Model type: string + title: Model prompt: anyOf: - type: string @@ -1692,49 +1714,40 @@ components: 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 @@ -1744,44 +1757,66 @@ components: 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 + additionalProperties: true + type: object required: - model - prompt title: OpenAICompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: + properties: + id: + type: string + title: Id + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + type: array + title: Choices + created: + type: integer + title: Created + model: + type: string + title: Model + object: + type: string + const: text_completion + title: Object + default: text_completion + type: object + required: + - id + - choices + - created + - model + title: OpenAICompletion description: |- Response from an OpenAI-compatible completion request. @@ -1790,34 +1825,29 @@ components: :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 OpenAICompletionChoice: + properties: + finish_reason: + type: string + title: Finish Reason + text: + type: string + title: Text + index: + type: integer + title: Index + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + title: OpenAIChoiceLogprobs + type: object + required: + - finish_reason + - text + - index + title: OpenAICompletionChoice description: |- A choice from an OpenAI-compatible completion response. @@ -1825,29 +1855,6 @@ components: :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 ConversationItem: discriminator: mapping: @@ -1882,54 +1889,55 @@ components: title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) OpenAIResponseAnnotationCitation: - description: URL citation annotation for referencing external web resources. properties: type: + type: string const: url_citation - default: url_citation title: Type - type: string + default: url_citation end_index: + type: integer title: End Index - type: integer start_index: - title: Start Index type: integer + title: Start Index title: + type: string title: Title - type: string url: - title: Url type: string + title: Url + type: object required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation - type: object + description: URL citation annotation for referencing external web resources. OpenAIResponseAnnotationContainerFileCitation: properties: type: + type: string const: container_file_citation - default: container_file_citation title: Type - type: string + default: container_file_citation container_id: + type: string title: Container Id - type: string end_index: + type: integer title: End Index - type: integer file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename start_index: - title: Start Index type: integer + title: Start Index + type: object required: - container_id - end_index @@ -1937,48 +1945,47 @@ components: - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation - type: object OpenAIResponseAnnotationFileCitation: - description: File citation annotation for referencing specific files in response content. properties: type: + type: string const: file_citation - default: file_citation title: Type - type: string + default: file_citation file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename index: - title: Index type: integer + title: Index + type: object required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation - type: object + description: File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: properties: type: + type: string const: file_path - default: file_path title: Type - type: string + default: file_path file_id: - title: File Id type: string + title: File Id index: - title: Index type: integer + title: Index + type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath - type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -1998,49 +2005,47 @@ components: title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: - description: Refusal content within a streamed response part. properties: type: + type: string const: refusal - default: refusal title: Type - type: string + default: refusal refusal: - title: Refusal type: string + title: Refusal + type: object required: - refusal title: OpenAIResponseContentPartRefusal - type: object + description: Refusal content within a streamed response part. OpenAIResponseInputFunctionToolCallOutput: - description: This represents the output of a function call that gets passed back to the model. properties: call_id: + type: string title: Call Id - type: string output: + type: string title: Output - type: string type: - const: function_call_output - default: function_call_output - title: Type type: string + const: function_call_output + title: Type + default: function_call_output id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput - type: object + description: This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: discriminator: mapping: @@ -2057,134 +2062,126 @@ components: title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseInputMessageContentFile: - description: File content for input messages in OpenAI response format. properties: type: - const: input_file - default: input_file - title: Type type: string + const: input_file + title: Type + default: input_file 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 + title: OpenAIResponseInputMessageContentFile + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: - description: Image content for input messages in OpenAI response format. properties: detail: - default: auto title: Detail + default: auto type: string enum: - low - high - auto type: - const: input_image - default: input_image - title: Type type: string + const: input_image + title: Type + default: input_image file_id: anyOf: - type: string - type: 'null' - nullable: true image_url: anyOf: - type: string - type: 'null' - nullable: true - title: OpenAIResponseInputMessageContentImage type: object + title: OpenAIResponseInputMessageContentImage + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: - description: Text content for input messages in OpenAI response format. properties: text: + type: string title: Text - type: string type: - const: input_text - default: input_text - title: Type type: string + const: input_text + title: Type + default: input_text + type: object required: - text title: OpenAIResponseInputMessageContentText - type: object + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: - description: A request for human approval of a tool invocation. properties: arguments: + type: string title: Arguments - type: string id: + type: string title: Id - type: string name: + type: string title: Name - type: string server_label: + type: string title: Server Label - type: string type: - const: mcp_approval_request - default: mcp_approval_request - title: Type type: string + const: mcp_approval_request + title: Type + default: mcp_approval_request + type: object required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest - type: object + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: - description: A response to an MCP approval request. properties: approval_request_id: + type: string title: Approval Request Id - type: string approve: - title: Approve type: boolean + title: Approve type: - const: mcp_approval_response - default: mcp_approval_response - title: Type type: string + const: mcp_approval_response + title: Type + default: mcp_approval_response id: anyOf: - type: string - type: 'null' - nullable: true reason: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse - type: object + description: A response to an MCP approval request. OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -2271,22 +2268,15 @@ components: OpenAIResponseOutputMessageContentOutputText: properties: text: + type: string title: Text - type: string type: - const: output_text - default: output_text - title: Type type: string + const: output_text + title: Type + default: output_text 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 @@ -2296,176 +2286,177 @@ components: title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath + discriminator: + propertyName: type + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - title: Annotations type: array + title: Annotations + type: object required: - text title: OpenAIResponseOutputMessageContentOutputText - type: object OpenAIResponseOutputMessageFileSearchToolCall: - description: File search tool call output message for OpenAI responses. properties: id: - title: Id type: string + title: Id queries: items: type: string - title: Queries type: array + title: Queries status: + type: string title: Status - type: string type: - const: file_search_call - default: file_search_call - title: Type type: string + const: file_search_call + title: Type + default: file_search_call results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' - nullable: true + type: object required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall - type: object + description: File search tool call output message for OpenAI responses. OpenAIResponseOutputMessageFunctionToolCall: - description: Function tool call output message for OpenAI responses. properties: call_id: + type: string title: Call Id - type: string name: + type: string title: Name - type: string arguments: + type: string title: Arguments - type: string type: - const: function_call - default: function_call - title: Type type: string + const: function_call + title: Type + default: function_call id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall - type: object + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: - description: Model Context Protocol (MCP) call output message for OpenAI responses. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_call - default: mcp_call title: Type - type: string + default: mcp_call arguments: + type: string title: Arguments - type: string name: + type: string title: Name - type: string server_label: - title: Server Label type: string + title: Server Label error: anyOf: - type: string - type: 'null' - nullable: true output: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall - type: object + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: - description: MCP list tools output message containing available tools from an MCP server. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_list_tools - default: mcp_list_tools title: Type - type: string + default: mcp_list_tools server_label: - title: Server Label type: string + title: Server Label tools: items: $ref: '#/components/schemas/MCPListToolsTool' - title: Tools type: array + title: Tools + type: object required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools - type: object + description: MCP list tools output message containing available tools from an MCP server. OpenAIResponseOutputMessageWebSearchToolCall: - description: Web search tool call output message for OpenAI responses. properties: id: + type: string title: Id - type: string status: + type: string title: Status - type: string type: - const: web_search_call - default: web_search_call - title: Type type: string + const: web_search_call + title: Type + default: web_search_call + type: object required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall - type: object + description: Web search tool call output message for OpenAI responses. Conversation: - description: OpenAI-compatible conversation object. properties: id: - description: The unique ID of the conversation. + type: string title: Id - type: string + description: The unique ID of the conversation. object: - const: conversation - default: conversation - description: The object type, which is always conversation. - title: Object type: string + const: conversation + title: Object + description: The object type, which is always conversation. + default: conversation created_at: - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - title: Created At type: integer + title: Created At + description: The time at which the conversation was created, measured in seconds since the Unix epoch. metadata: anyOf: - additionalProperties: @@ -2473,7 +2464,6 @@ components: 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: @@ -2482,59 +2472,45 @@ components: 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 + type: object required: - id - created_at title: Conversation - type: object + description: OpenAI-compatible conversation object. ConversationDeletedResource: - description: Response for deleted conversation. properties: id: - description: The deleted conversation identifier + type: string title: Id - type: string + description: The deleted conversation identifier object: - default: conversation.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationDeletedResource - type: object + description: Response for deleted conversation. ConversationItemList: - description: List of conversation items with pagination. properties: object: - default: list - description: Object type - title: Object type: string + title: Object + description: Object type + default: list 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -2551,58 +2527,68 @@ components: title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - title: Data + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (9 variants) type: array + title: Data + description: List of conversation items 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 + title: Has More + description: Whether there are more items available + default: false + type: object required: - data title: ConversationItemList - type: object + description: List of conversation items with pagination. ConversationItemDeletedResource: - description: Response for deleted conversation item. properties: id: - description: The deleted item identifier + type: string title: Id - type: string + description: The deleted item identifier object: - default: conversation.item.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.item.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationItemDeletedResource - type: object + description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible embeddings endpoint. properties: model: - title: Model type: string + title: Model input: anyOf: - type: string @@ -2620,25 +2606,24 @@ components: anyOf: - type: integer - type: 'null' - nullable: true user: anyOf: - type: string - type: 'null' - nullable: true + additionalProperties: true + type: object required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: - description: A single embedding data object from an OpenAI-compatible embeddings response. properties: object: - const: embedding - default: embedding - title: Object type: string + const: embedding + title: Object + default: embedding embedding: anyOf: - items: @@ -2648,112 +2633,113 @@ components: - type: string title: list[number] | string index: - title: Index type: integer + title: Index + type: object required: - embedding - index title: OpenAIEmbeddingData - type: object + description: A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: - description: Usage information for an OpenAI-compatible embeddings response. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens + type: object required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage - type: object + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: - description: Response from an OpenAI-compatible embeddings request. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' - title: Data type: array + title: Data model: - title: Model type: string + title: Model usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' + type: object required: - data - model - usage title: OpenAIEmbeddingsResponse - type: object + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: - description: Valid purpose values for OpenAI Files API. + type: string enum: - assistants - batch title: OpenAIFilePurpose - type: string + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: - description: Response for listing files in OpenAI Files API. properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse - type: object + description: Response for listing files in OpenAI Files API. OpenAIFileObject: - description: OpenAI File object as defined in the OpenAI Files API. properties: object: + type: string const: file - default: file title: Object - type: string + default: file id: + type: string title: Id - type: string bytes: + type: integer title: Bytes - type: integer created_at: + type: integer title: Created At - type: integer expires_at: - title: Expires At type: integer + title: Expires At filename: - title: Filename type: string + title: Filename purpose: $ref: '#/components/schemas/OpenAIFilePurpose' + type: object required: - id - bytes @@ -2762,90 +2748,116 @@ components: - filename - purpose title: OpenAIFileObject - type: object + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: + properties: + anchor: + type: string + const: created_at + title: Anchor + seconds: + type: integer + maximum: 2592000.0 + minimum: 3600.0 + title: Seconds + type: object + required: + - anchor + - seconds + title: 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 OpenAIFileDeleteResponse: - description: Response for deleting a file in OpenAI Files API. properties: id: + type: string title: Id - type: string object: - const: file - default: file - title: Object type: string + const: file + title: Object + default: file deleted: - title: Deleted type: boolean + title: Deleted + type: object required: - id - deleted title: OpenAIFileDeleteResponse - type: object + description: Response for deleting a file in OpenAI Files API. HealthInfo: - description: Health status information for the service. properties: status: $ref: '#/components/schemas/HealthStatus' + type: object required: - status title: HealthInfo - type: object + description: Health status information for the service. RouteInfo: - description: Information about an API route including its path, method, and implementing providers. properties: route: + type: string title: Route - type: string method: - title: Method type: string + title: Method provider_types: items: type: string - title: Provider Types type: array + title: Provider Types + type: object required: - route - method - provider_types title: RouteInfo - type: object + description: Information about an API route including its path, method, and implementing providers. ListRoutesResponse: - description: Response containing a list of all available API routes. properties: data: items: $ref: '#/components/schemas/RouteInfo' - title: Data type: array + title: Data + type: object required: - data title: ListRoutesResponse - type: object + description: Response containing a list of all available API routes. OpenAIModel: + properties: + id: + type: string + title: Id + object: + type: string + const: model + title: Object + default: model + created: + type: integer + title: Created + owned_by: + type: string + title: Owned By + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - id + - created + - owned_by + title: OpenAIModel description: |- A model from OpenAI. @@ -2854,120 +2866,90 @@ components: :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 + title: Data + type: object required: - data title: OpenAIListModelsResponse - type: object 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: model - default: model - title: Type type: string + const: model + title: Type + default: model metadata: additionalProperties: true - description: Any additional metadata for this model - title: Metadata type: object + title: Metadata + description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm + type: object required: - identifier - provider_id title: Model - type: object + description: A model resource representing an AI model registered in Llama Stack. ModelType: - description: Enumeration of supported model types in Llama Stack. + type: string enum: - llm - embedding - rerank title: ModelType - type: string + description: Enumeration of supported model types in Llama Stack. ModerationObject: - description: A moderation object. properties: id: + type: string title: Id - type: string model: - title: Model type: string + title: Model results: items: $ref: '#/components/schemas/ModerationObjectResults' - title: Results type: array + title: Results + type: object required: - id - model - results title: ModerationObject - type: object - ModerationObjectResults: description: A moderation object. + ModerationObjectResults: properties: flagged: - title: Flagged type: boolean + title: Flagged categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' - nullable: true category_applied_input_types: anyOf: - additionalProperties: @@ -2976,93 +2958,90 @@ components: 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 + title: Metadata + type: object required: - flagged title: ModerationObjectResults - type: object + description: A moderation 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 + minimum: 1.0 + title: Version + description: Version (integer starting at 1, incremented on save) prompt_id: - description: Unique identifier in format 'pmpt_<48-digit-hash>' - title: Prompt Id type: string + title: Prompt Id + description: Unique identifier in format 'pmpt_<48-digit-hash>' variables: - description: List of variable names that can be used in the prompt template items: type: string - title: Variables type: array + title: Variables + description: List of variable names that can be used in the prompt template is_default: - default: false - description: Boolean indicating whether this version is the default version - title: Is Default type: boolean + title: Is Default + description: Boolean indicating whether this version is the default version + default: false + type: object required: - version - prompt_id title: Prompt - type: object + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. ListPromptsResponse: - description: Response model to list prompts. properties: data: items: $ref: '#/components/schemas/Prompt' - title: Data type: array + title: Data + type: object required: - data title: ListPromptsResponse - type: object + description: Response model to list prompts. ProviderInfo: - description: Information about a registered provider including its configuration and health status. properties: api: + type: string title: Api - type: string provider_id: + type: string title: Provider Id - type: string provider_type: - title: Provider Type type: string + title: Provider Type config: additionalProperties: true - title: Config type: object + title: Config health: additionalProperties: true - title: Health type: object + title: Health + type: object required: - api - provider_id @@ -3070,62 +3049,62 @@ components: - config - health title: ProviderInfo - type: object + description: Information about a registered provider including its configuration and health status. ListProvidersResponse: - description: Response containing a list of all available providers. properties: data: items: $ref: '#/components/schemas/ProviderInfo' - title: Data type: array + title: Data + type: object required: - data title: ListProvidersResponse - type: object + description: Response containing a list of all available providers. ListOpenAIResponseObject: - description: Paginated list of OpenAI response objects with navigation metadata. properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject - type: object + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: - description: Error details for failed OpenAI response requests. properties: code: + type: string title: Code - type: string message: - title: Message type: string + title: Message + type: object required: - code - message title: OpenAIResponseError - type: object + description: Error details for failed OpenAI response requests. OpenAIResponseInput: anyOf: - discriminator: @@ -3162,29 +3141,27 @@ components: title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage OpenAIResponseInputToolFileSearch: - description: File search tool configuration for OpenAI response inputs. properties: type: - const: file_search - default: file_search - title: Type type: string + const: file_search + title: Type + default: file_search vector_store_ids: items: type: string - title: Vector Store Ids type: array + title: Vector Store Ids filters: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true max_num_results: anyOf: - - maximum: 50 - minimum: 1 - type: integer + - type: integer + maximum: 50.0 + minimum: 1.0 - type: 'null' default: 10 ranking_options: @@ -3192,28 +3169,26 @@ components: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' - nullable: true title: SearchRankingOptions + type: object required: - vector_store_ids title: OpenAIResponseInputToolFileSearch - type: object + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: - description: Function tool configuration for OpenAI response inputs. properties: type: + type: string const: function - default: function title: Type - type: string + default: function name: - title: Name type: string + title: Name description: anyOf: - type: string - type: 'null' - nullable: true parameters: anyOf: - additionalProperties: true @@ -3223,18 +3198,17 @@ components: anyOf: - type: boolean - type: 'null' - nullable: true + type: object required: - name - parameters title: OpenAIResponseInputToolFunction - type: object + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: - description: Web search tool configuration for OpenAI response inputs. properties: type: - default: web_search title: Type + default: web_search type: string enum: - web_search @@ -3243,51 +3217,40 @@ components: - web_search_2025_08_26 search_context_size: anyOf: - - pattern: ^low|medium|high$ - type: string + - type: string + pattern: ^low|medium|high$ - type: 'null' default: medium - title: OpenAIResponseInputToolWebSearch type: object + title: OpenAIResponseInputToolWebSearch + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: - description: OpenAI response object extended with input context information. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -3300,33 +3263,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -3336,20 +3306,9 @@ components: 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 @@ -3359,48 +3318,43 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -3413,16 +3367,27 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Input + type: object required: - created_at - id @@ -3431,7 +3396,7 @@ components: - status - input title: OpenAIResponseObjectWithInput - type: object + description: OpenAI response object extended with input context information. OpenAIResponseOutput: discriminator: mapping: @@ -3460,20 +3425,13 @@ components: title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) OpenAIResponsePrompt: - description: OpenAI compatible Prompt object that is used in OpenAI responses. properties: id: - title: Id type: string + title: Id 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 @@ -3481,31 +3439,35 @@ components: title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' - nullable: true version: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id title: OpenAIResponsePrompt - type: object + description: OpenAI compatible Prompt object that is used in OpenAI responses. 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 + title: OpenAIResponseText + description: Text response configuration for OpenAI responses. OpenAIResponseTool: discriminator: mapping: @@ -3528,16 +3490,15 @@ components: title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: - title: Server Label type: string + title: Server Label allowed_tools: anyOf: - items: @@ -3548,43 +3509,41 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label title: OpenAIResponseToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. OpenAIResponseUsage: - description: Usage information for OpenAI response. properties: input_tokens: + type: integer title: Input Tokens - type: integer output_tokens: + type: integer title: Output Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - input_tokens - output_tokens - total_tokens title: OpenAIResponseUsage - type: object + description: Usage information for OpenAI response. ResponseGuardrailSpec: description: Specification for a guardrail to apply during response generation. properties: @@ -3617,40 +3576,37 @@ components: title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseInputToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: + type: string title: Server Label - type: string server_url: - title: Server Url type: string + title: Server Url 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 + - type: string + const: always + - type: string + const: never - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter - default: never title: string | ApprovalFilter + default: never allowed_tools: anyOf: - items: @@ -3661,51 +3617,39 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label - server_url title: OpenAIResponseInputToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseObject: - description: Complete OpenAI response object containing generation results and metadata. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -3718,33 +3662,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -3754,20 +3705,9 @@ components: 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 @@ -3777,32 +3717,38 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + type: object required: - created_at - id @@ -3810,7 +3756,7 @@ components: - output - status title: OpenAIResponseObject - type: object + description: Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: @@ -4974,43 +4920,32 @@ components: title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: - description: Response object confirming deletion of an OpenAI response. properties: id: + type: string title: Id - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: OpenAIDeleteResponseObject - type: object + description: Response object confirming deletion of an OpenAI response. 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5023,39 +4958,48 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Data object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data title: ListOpenAIResponseInputItem - type: object + description: List container for OpenAI response input items. 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 + title: RunShieldResponse + description: Response from running a safety shield. SafetyViolation: - description: Details of a safety violation detected by content moderation. properties: violation_level: $ref: '#/components/schemas/ViolationLevel' @@ -5063,25 +5007,25 @@ components: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - title: Metadata type: object + title: Metadata + type: object required: - violation_level title: SafetyViolation - type: object + description: Details of a safety violation detected by content moderation. ViolationLevel: - description: Severity level of a safety violation. + type: string enum: - info - warn - error title: ViolationLevel - type: string + description: Severity level of a safety violation. AggregationFunctionType: - description: Types of aggregation functions for scoring results. + type: string enum: - average - weighted_average @@ -5089,193 +5033,176 @@ components: - categorical_count - accuracy title: AggregationFunctionType - type: string + description: Types of aggregation functions for scoring results. ArrayType: - description: Parameter type for array values. properties: type: + type: string const: array - default: array title: Type - type: string - title: ArrayType + default: array type: object + title: ArrayType + description: Parameter type for array values. BasicScoringFnParams: - description: Parameters for basic scoring function configuration. properties: type: - const: basic - default: basic - title: Type type: string + const: basic + title: Type + default: basic aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object title: BasicScoringFnParams - type: object + description: Parameters for basic scoring function configuration. BooleanType: - description: Parameter type for boolean values. properties: type: + type: string const: boolean + title: Type default: boolean - title: Type - type: string + type: object title: BooleanType - type: object + description: Parameter type for boolean values. ChatCompletionInputType: - description: Parameter type for chat completion input. properties: type: + type: string const: chat_completion_input + title: Type default: chat_completion_input - title: Type - type: string + type: object title: ChatCompletionInputType - type: object + description: Parameter type for chat completion input. CompletionInputType: - description: Parameter type for completion input. properties: type: + type: string const: completion_input + title: Type default: completion_input - title: Type - type: string + type: object title: CompletionInputType - type: object + description: Parameter type for completion input. JsonType: - description: Parameter type for JSON values. properties: type: + type: string const: json - default: json title: Type - type: string - title: JsonType + default: json type: object + title: JsonType + description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: - description: Parameters for LLM-as-judge scoring function configuration. properties: type: + type: string const: llm_as_judge - default: llm_as_judge title: Type - type: string + default: llm_as_judge judge_model: - title: Judge Model type: string + title: Judge Model 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 + title: Judge Score Regexes + description: Regexes to extract the answer from generated response aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object required: - judge_model title: LLMAsJudgeScoringFnParams - type: object + description: Parameters for LLM-as-judge scoring function configuration. NumberType: - description: Parameter type for numeric values. properties: type: + type: string const: number + title: Type default: number - title: Type - type: string + type: object title: NumberType - type: object + description: Parameter type for numeric values. ObjectType: - description: Parameter type for object values. properties: type: + type: string const: object - default: object title: Type - type: string - title: ObjectType + default: object type: object + title: ObjectType + description: Parameter type for object values. RegexParserScoringFnParams: - description: Parameters for regex parser scoring function configuration. properties: type: - const: regex_parser - default: regex_parser - title: Type type: string + const: regex_parser + title: Type + default: regex_parser parsing_regexes: - description: Regex to extract the answer from generated response items: type: string - title: Parsing Regexes type: array + title: Parsing Regexes + description: Regex to extract the answer from generated response 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 + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row type: object + title: RegexParserScoringFnParams + description: Parameters for regex parser scoring function configuration. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: scoring_function - default: scoring_function - title: Type type: string + const: scoring_function + title: Type + default: scoring_function description: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - description: Any additional metadata for this definition - title: Metadata type: object + title: Metadata + description: Any additional metadata for this definition 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 @@ -5296,32 +5223,45 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + description: The return type of the deterministic function + discriminator: + propertyName: type + 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' params: anyOf: - - discriminator: - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - propertyName: type - oneOf: + - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + type: object required: - identifier - provider_id - return_type title: ScoringFn - type: object + description: A scoring function resource for evaluating model outputs. ScoringFnParams: discriminator: mapping: @@ -5338,127 +5278,124 @@ components: title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams StringType: - description: Parameter type for string values. properties: type: + type: string const: string - default: string title: Type - type: string - title: StringType + default: string type: object + title: StringType + description: Parameter type for string values. UnionType: - description: Parameter type for union values. properties: type: - const: union - default: union - title: Type type: string - title: UnionType + const: union + title: Type + default: union type: object + title: UnionType + description: Parameter type for union values. ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' - title: Data type: array + title: Data + type: object required: - data title: ListScoringFunctionsResponse - type: object ScoreResponse: - description: The response from scoring. properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Results type: object + title: Results + type: object required: - results title: ScoreResponse - type: object + description: The response from scoring. ScoringResult: - description: A scoring result for a single row. properties: score_rows: items: additionalProperties: true type: object - title: Score Rows type: array + title: Score Rows aggregated_results: additionalProperties: true - title: Aggregated Results type: object + title: Aggregated Results + type: object required: - score_rows - aggregated_results title: ScoringResult - type: object + description: A scoring result for a single row. 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 + title: Results + type: object required: - results title: ScoreBatchResponse - type: object + description: Response from batch scoring operations on datasets. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: shield - default: shield - title: Type type: string + const: shield + title: Type + default: shield params: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true + type: object required: - identifier - provider_id title: Shield - type: object + description: A safety shield resource that can be used to check content. ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' - title: Data type: array + title: Data + type: object required: - data title: ListShieldsResponse - type: object ImageContentItem: description: A image content item properties: @@ -5515,184 +5452,172 @@ components: title: TextContentItem title: ImageContentItem | TextContentItem TextContentItem: - description: A text content item properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: TextContentItem - type: object + description: A text content item 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 + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Output | TextContentItem] - type: 'null' - title: string | list[ImageContentItem | TextContentItem] - nullable: true + title: string | list[ImageContentItem-Output | TextContentItem] 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 + title: ToolInvocationResult + description: Result of a tool invocation. URL: - description: A URL reference to external content. properties: uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URL - type: object + description: A URL reference to external content. ToolDef: - description: Tool definition used in runtime contexts. properties: toolgroup_id: anyOf: - type: string - type: 'null' - nullable: true name: - title: Name type: string + title: Name 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 + type: object required: - name title: ToolDef - type: object + description: Tool definition used in runtime contexts. ListToolDefsResponse: - description: Response containing a list of tool definitions. properties: data: items: $ref: '#/components/schemas/ToolDef' - title: Data type: array + title: Data + type: object required: - data title: ListToolDefsResponse - type: object + description: Response containing a list of tool definitions. ToolGroup: - description: A group of related tools managed together. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: tool_group - default: tool_group - title: Type type: string + const: tool_group + title: Type + default: tool_group 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 + type: object required: - identifier - provider_id title: ToolGroup - type: object + description: A group of related tools managed together. ListToolGroupsResponse: - description: Response containing a list of tool groups. properties: data: items: $ref: '#/components/schemas/ToolGroup' - title: Data type: array + title: Data + type: object required: - data title: ListToolGroupsResponse - type: object + description: Response containing a list of tool groups. Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -5752,105 +5677,94 @@ components: title: Chunk 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 + title: 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. QueryChunksResponse: - description: Response from querying chunks in a vector database. properties: chunks: items: - $ref: '#/components/schemas/Chunk' - title: Chunks + $ref: '#/components/schemas/Chunk-Output' type: array + title: Chunks scores: items: type: number - title: Scores type: array + title: Scores + type: object required: - chunks - scores title: QueryChunksResponse - type: object + description: Response from querying chunks in a vector database. VectorStoreFileCounts: - description: File processing status counts for a vector store. properties: completed: + type: integer title: Completed - type: integer cancelled: + type: integer title: Cancelled - type: integer failed: + type: integer title: Failed - type: integer in_progress: + type: integer title: In Progress - type: integer total: - title: Total type: integer + title: Total + type: object required: - completed - cancelled @@ -5858,91 +5772,85 @@ components: - in_progress - total title: VectorStoreFileCounts - type: object + description: File processing status counts for a vector store. VectorStoreListResponse: - description: Response from listing vector stores. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListResponse - type: object + description: Response from listing vector stores. VectorStoreObject: - description: OpenAI Vector Store object. properties: id: + type: string title: Id - type: string object: - default: vector_store - title: Object type: string + title: Object + default: vector_store created_at: - title: Created At type: integer + title: Created At name: anyOf: - type: string - type: 'null' - nullable: true usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: - default: completed - title: Status type: string + title: Status + default: completed 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 + title: Metadata + type: object required: - id - created_at - file_counts title: VectorStoreObject - type: object + description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: @@ -5956,159 +5864,151 @@ components: title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreChunkingStrategyAuto: - description: Automatic chunking strategy for vector store files. properties: type: + type: string const: auto - default: auto title: Type - type: string - title: VectorStoreChunkingStrategyAuto + default: auto type: object + title: VectorStoreChunkingStrategyAuto + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: - description: Static chunking strategy with configurable parameters. properties: type: - const: static - default: static - title: Type type: string + const: static + title: Type + default: static static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + type: object required: - static title: VectorStoreChunkingStrategyStatic - type: object + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: - description: Configuration for static chunking strategy. properties: chunk_overlap_tokens: - default: 400 + type: integer title: Chunk Overlap Tokens - type: integer + default: 400 max_chunk_size_tokens: - default: 800 - maximum: 4096 - minimum: 100 - title: Max Chunk Size Tokens type: integer - title: VectorStoreChunkingStrategyStaticConfig + maximum: 4096.0 + minimum: 100.0 + title: Max Chunk Size Tokens + default: 800 type: object + title: VectorStoreChunkingStrategyStaticConfig + description: Configuration for static chunking strategy. 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true - title: OpenAICreateVectorStoreRequestWithExtraBody + additionalProperties: true type: object + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. VectorStoreDeleteResponse: - description: Response from deleting a vector store. properties: id: + type: string title: Id - type: string object: - default: vector_store.deleted - title: Object type: string + title: Object + default: vector_store.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreDeleteResponse - type: object + description: Response from deleting a vector store. 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 + title: File Ids 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true + additionalProperties: true + type: object required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - type: object + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: - description: OpenAI Vector Store File Batch object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file_batch + type: string title: Object - type: string + default: vector_store.file_batch created_at: - title: Created At type: integer + title: Created At vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id status: title: Status type: string @@ -6120,6 +6020,7 @@ components: default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' + type: object required: - id - created_at @@ -6127,7 +6028,7 @@ components: - status - file_counts title: VectorStoreFileBatchObject - type: object + description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: type: string enum: @@ -6137,7 +6038,6 @@ components: - failed default: completed VectorStoreFileLastError: - description: Error information for failed vector store file processing. properties: code: title: Code @@ -6147,48 +6047,47 @@ components: - rate_limit_exceeded default: server_error message: - title: Message type: string + title: Message + type: object required: - code - message title: VectorStoreFileLastError - type: object + description: Error information for failed vector store file processing. VectorStoreFileObject: - description: OpenAI Vector Store File object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file - title: Object type: string + title: Object + default: vector_store.file attributes: additionalProperties: true - title: Attributes type: object + title: Attributes 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 + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' created_at: - title: Created At type: integer + title: Created At last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' - nullable: true title: VectorStoreFileLastError status: title: Status @@ -6200,12 +6099,13 @@ components: - failed default: completed usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id + type: object required: - id - chunking_strategy @@ -6213,158 +6113,149 @@ components: - status - vector_store_id title: VectorStoreFileObject - type: object + description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: - description: Response from listing files in a vector store file batch. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreFilesListInBatchResponse - type: object + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: - description: Response from listing files in a vector store. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListFilesResponse - type: object + description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: - description: Response from deleting a vector store file. properties: id: + type: string title: Id - type: string object: - default: vector_store.file.deleted - title: Object type: string + title: Object + default: vector_store.file.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreFileDeleteResponse - type: object + description: Response from deleting a vector store file. VectorStoreContent: - description: Content item from a vector store file or search result. properties: type: + type: string const: text title: Type - type: string text: - title: Text type: string + title: Text 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 + type: object required: - type - text title: VectorStoreContent - type: object + description: Content item from a vector store file or search result. 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 + const: vector_store.file_content.page + title: Object + default: vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data title: VectorStoreFileContentResponse - type: object + description: Represents the parsed content of a vector store file. VectorStoreSearchResponse: - description: Response from searching a vector store. properties: file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename score: - title: Score type: number + title: Score attributes: anyOf: - additionalProperties: @@ -6375,241 +6266,230 @@ components: title: string | number | boolean type: object - type: 'null' - nullable: true content: items: $ref: '#/components/schemas/VectorStoreContent' - title: Content type: array + title: Content + type: object required: - file_id - filename - score - content title: VectorStoreSearchResponse - type: object + description: Response from searching a vector store. VectorStoreSearchResponsePage: - description: Paginated response from searching a vector store. properties: object: - default: vector_store.search_results.page - title: Object type: string + title: Object + default: vector_store.search_results.page search_query: items: type: string - title: Search Query type: array + title: Search Query data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - search_query - data title: VectorStoreSearchResponsePage - type: object + description: Paginated response from searching a vector store. VersionInfo: - description: Version information for the service. properties: version: - title: Version type: string + title: Version + type: object required: - version title: VersionInfo - type: object + description: Version information for the service. PaginatedResponse: - description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More url: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data - has_more title: PaginatedResponse - type: object + description: A generic paginated response that follows a simple format. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: dataset - default: dataset - title: Type type: string + const: dataset + title: Type + default: dataset 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 + discriminator: + propertyName: type + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' metadata: additionalProperties: true - description: Any additional metadata for this dataset - title: Metadata type: object + title: Metadata + description: Any additional metadata for this dataset + type: object required: - identifier - provider_id - purpose - source title: Dataset - type: object + description: Dataset resource for storing and accessing training or evaluation data. RowsDataSource: - description: A dataset stored in rows. properties: type: - const: rows - default: rows - title: Type type: string + const: rows + title: Type + default: rows rows: items: additionalProperties: true type: object - title: Rows type: array + title: Rows + type: object required: - rows title: RowsDataSource - type: object + description: A dataset stored in rows. URIDataSource: - description: A dataset that can be obtained from a URI. properties: type: + type: string const: uri - default: uri title: Type - type: string + default: uri uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URIDataSource - type: object + description: A dataset that can be obtained from a URI. ListDatasetsResponse: - description: Response from listing datasets. properties: data: items: $ref: '#/components/schemas/Dataset' - title: Data type: array + title: Data + type: object required: - data title: ListDatasetsResponse - type: object + description: Response from listing datasets. Benchmark: - description: A benchmark resource for evaluating model performance. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: + type: string const: benchmark - default: benchmark title: Type - type: string + default: benchmark dataset_id: - title: Dataset Id type: string + title: Dataset Id scoring_functions: items: type: string - title: Scoring Functions type: array + title: Scoring Functions metadata: additionalProperties: true - description: Metadata for this evaluation task - title: Metadata type: object + title: Metadata + description: Metadata for this evaluation task + type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark - type: object + description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' - title: Data type: array + title: Data + type: object required: - data title: ListBenchmarksResponse - 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 @@ -6617,41 +6497,46 @@ components: title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + title: Scoring Params + description: Map between scoring function id and parameters for each scoring function you want to run 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 + type: object required: - eval_candidate title: BenchmarkConfig - type: object + description: A benchmark configuration for evaluation. GreedySamplingStrategy: - description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: + type: string const: greedy - default: greedy title: Type - type: string - title: GreedySamplingStrategy + default: greedy type: object + title: GreedySamplingStrategy + description: Greedy sampling strategy that selects the highest probability token at each step. ModelCandidate: - description: A model candidate for evaluation. properties: type: + type: string const: model - default: model title: Type - type: string + default: model model: - title: Model type: string + title: Model sampling_params: $ref: '#/components/schemas/SamplingParams' system_message: @@ -6659,23 +6544,16 @@ components: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' - nullable: true title: SystemMessage + type: object required: - model - sampling_params title: ModelCandidate - type: object + description: A model candidate for evaluation. 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 @@ -6684,11 +6562,16 @@ components: - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + discriminator: + propertyName: type + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' max_tokens: anyOf: - type: integer - type: 'null' - nullable: true repetition_penalty: anyOf: - type: number @@ -6700,74 +6583,73 @@ components: type: string type: array - type: 'null' - nullable: true - title: SamplingParams type: object + title: SamplingParams + description: Sampling parameters. SystemMessage: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string - - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type - oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] - title: string | list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + type: object required: - content title: SystemMessage - type: object + description: A system message providing instructions or context to the model. 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 + const: top_k + title: Type + default: top_k top_k: - minimum: 1 - title: Top K type: integer + minimum: 1.0 + title: Top K + type: object required: - top_k title: TopKSamplingStrategy - type: object + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. 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 + const: top_p + title: Type + default: top_p temperature: anyOf: - type: number @@ -6778,94 +6660,94 @@ components: - type: number - type: 'null' default: 0.95 + type: object required: - temperature title: TopPSamplingStrategy - type: object + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. EvaluateResponse: - description: The response from an evaluation. properties: generations: items: additionalProperties: true type: object - title: Generations type: array + title: Generations scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Scores type: object + title: Scores + type: object required: - generations - scores title: EvaluateResponse - type: object + description: The response from an evaluation. Job: - description: A job execution instance with status tracking. properties: job_id: - title: Job Id type: string + title: Job Id status: $ref: '#/components/schemas/JobStatus' + type: object required: - job_id - status title: Job - type: object + description: A job execution instance with status tracking. RerankData: - description: A single rerank result from a reranking response. properties: index: - title: Index type: integer + title: Index relevance_score: - title: Relevance Score type: number + title: Relevance Score + type: object required: - index - relevance_score title: RerankData - type: object + description: A single rerank result from a reranking response. RerankResponse: - description: Response from a reranking request. properties: data: items: $ref: '#/components/schemas/RerankData' - title: Data type: array + title: Data + type: object required: - data title: RerankResponse - type: object + description: Response from a reranking request. Checkpoint: - description: Checkpoint created during training runs. properties: identifier: - title: Identifier type: string + title: Identifier created_at: + type: string format: date-time title: Created At - type: string epoch: - title: Epoch type: integer + title: Epoch post_training_job_id: + type: string title: Post Training Job Id - type: string path: - title: Path type: string + title: Path training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' - nullable: true title: PostTrainingMetric + type: object required: - identifier - created_at @@ -6873,137 +6755,131 @@ components: - post_training_job_id - path title: Checkpoint - type: object + description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: - description: Artifacts of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid checkpoints: items: $ref: '#/components/schemas/Checkpoint' - title: Checkpoints type: array + title: Checkpoints + type: object required: - job_uuid title: PostTrainingJobArtifactsResponse - type: object + description: Artifacts of a finetuning job. PostTrainingMetric: - description: Training metrics captured during post-training jobs. properties: epoch: - title: Epoch type: integer + title: Epoch train_loss: + type: number title: Train Loss - type: number validation_loss: + type: number title: Validation Loss - type: number perplexity: - title: Perplexity type: number + title: Perplexity + type: object required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric - type: object + description: Training metrics captured during post-training jobs. PostTrainingJobStatusResponse: - description: Status of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true started_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true completed_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - 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 + title: Checkpoints + type: object required: - job_uuid - status title: PostTrainingJobStatusResponse - type: object + description: Status of a finetuning job. ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' - title: Data type: array + title: Data + type: object required: - data title: ListPostTrainingJobsResponse - type: object DPOAlignmentConfig: - description: Configuration for Direct Preference Optimization (DPO) alignment. properties: beta: - title: Beta type: number + title: Beta loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid + type: object required: - beta title: DPOAlignmentConfig - type: object + description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: + type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType - type: string DataConfig: - description: Configuration for training data and data loading. properties: dataset_id: - title: Dataset Id type: string + title: Dataset Id batch_size: - title: Batch Size type: integer + title: Batch Size shuffle: - title: Shuffle type: boolean + title: Shuffle data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' - nullable: true packed: anyOf: - type: boolean @@ -7014,22 +6890,22 @@ components: - type: boolean - type: 'null' default: false + type: object required: - dataset_id - batch_size - shuffle - data_format title: DataConfig - type: object + description: Configuration for training data and data loading. DatasetFormat: - description: Format of the training dataset. + type: string enum: - instruct - dialog title: DatasetFormat - type: string + description: Format of the training dataset. EfficiencyConfig: - description: Configuration for memory and compute efficiency optimizations. properties: enable_activation_checkpointing: anyOf: @@ -7051,51 +6927,51 @@ components: - type: boolean - type: 'null' default: false - title: EfficiencyConfig type: object + title: EfficiencyConfig + description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: - description: Configuration parameters for the optimization algorithm. properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: + type: number title: Lr - type: number weight_decay: - title: Weight Decay type: number + title: Weight Decay num_warmup_steps: - title: Num Warmup Steps type: integer + title: Num Warmup Steps + type: object required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig - type: object + description: Configuration parameters for the optimization algorithm. OptimizerType: - description: Available optimizer algorithms for training. + type: string enum: - adam - adamw - sgd title: OptimizerType - type: string + description: Available optimizer algorithms for training. TrainingConfig: - description: Comprehensive configuration for the training process. properties: n_epochs: + type: integer title: N Epochs - type: integer max_steps_per_epoch: - default: 1 + type: integer title: Max Steps Per Epoch - type: integer - gradient_accumulation_steps: default: 1 - title: Gradient Accumulation Steps + gradient_accumulation_steps: type: integer + title: Gradient Accumulation Steps + default: 1 max_validation_steps: anyOf: - type: integer @@ -7106,40 +6982,38 @@ components: - $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 + type: object required: - n_epochs title: TrainingConfig - type: object + description: Comprehensive configuration for the training process. PostTrainingJob: properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid + type: object required: - job_uuid title: PostTrainingJob - type: object AlgorithmConfig: discriminator: mapping: @@ -7153,30 +7027,29 @@ components: title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig LoraFinetuningConfig: - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. properties: type: - const: LoRA - default: LoRA - title: Type type: string + const: LoRA + title: Type + default: LoRA lora_attn_modules: items: type: string - title: Lora Attn Modules type: array + title: Lora Attn Modules apply_lora_to_mlp: + type: boolean title: Apply Lora To Mlp - type: boolean apply_lora_to_output: - title: Apply Lora To Output type: boolean + title: Apply Lora To Output rank: + type: integer title: Rank - type: integer alpha: - title: Alpha type: integer + title: Alpha use_dora: anyOf: - type: boolean @@ -7187,6 +7060,7 @@ components: - type: boolean - type: 'null' default: false + type: object required: - lora_attn_modules - apply_lora_to_mlp @@ -7194,26 +7068,26 @@ components: - rank - alpha title: LoraFinetuningConfig - type: object + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. properties: type: + type: string const: QAT - default: QAT title: Type - type: string + default: QAT quantizer_name: - title: Quantizer Name type: string + title: Quantizer Name group_size: - title: Group Size type: integer + title: Group Size + type: object required: - quantizer_name - group_size title: QATFinetuningConfig - type: object + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. ParamType: discriminator: mapping: @@ -7259,24 +7133,714 @@ components: - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource + AllowedToolsFilter: + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can be used. + ApprovalFilter: + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. + BatchError: + properties: + code: + anyOf: + - type: string + - type: 'null' + line: + anyOf: + - type: integer + - type: 'null' + message: + anyOf: + - type: string + - type: 'null' + param: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: BatchError + BatchRequestCounts: + properties: + completed: + type: integer + title: Completed + failed: + type: integer + title: Failed + total: + type: integer + title: Total + additionalProperties: true + type: object + required: + - completed + - failed + - total + title: BatchRequestCounts + BatchUsage: + properties: + input_tokens: + type: integer + title: Input Tokens + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + type: integer + title: Output Tokens + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + type: integer + title: Total Tokens + additionalProperties: true + type: object + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + Chunk-Output: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + type: array + title: list[ImageContentItem-Output | TextContentItem] + title: string | list[ImageContentItem-Output | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + DatasetPurpose: + type: string + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + description: Purpose of the dataset. Each purpose has a required input data schema. + Errors: + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + object: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: Errors + HealthStatus: + type: string + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + ImageContentItem-Input: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + ImageContentItem-Output: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + InputTokensDetails: + properties: + cached_tokens: + type: integer + title: Cached Tokens + additionalProperties: true + type: object + required: + - cached_tokens + title: InputTokensDetails + JobStatus: + type: string + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + description: Status of a job execution. + MCPListToolsTool: + properties: + input_schema: + additionalProperties: true + type: object + title: Input Schema + name: + type: string + title: Name + description: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_schema + - name + title: MCPListToolsTool + description: Tool definition returned by MCP list tools operation. + OpenAIAssistantMessageParam-Input: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIAssistantMessageParam-Output: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIChatCompletionUsageCompletionTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. + OpenAIChatCompletionUsagePromptTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. + OpenAIResponseMessage-Output: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseOutputMessageFileSearchToolCallResults: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + file_id: + type: string + title: File Id + filename: + type: string + title: Filename + score: + type: number + title: Score + text: + type: string + title: Text + type: object + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + OpenAIResponseTextFormat: + 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' + type: object + title: OpenAIResponseTextFormat + description: Configuration for Responses API text format. + OpenAIResponseUsageInputTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageInputTokensDetails + description: Token details for input tokens in OpenAI response usage. + OpenAIResponseUsageOutputTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageOutputTokensDetails + description: Token details for output tokens in OpenAI response usage. + OpenAIUserMessageParam-Input: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OpenAIUserMessageParam-Output: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OutputTokensDetails: + properties: + reasoning_tokens: + type: integer + title: Reasoning Tokens + additionalProperties: true + type: object + required: + - reasoning_tokens + title: OutputTokensDetails + SearchRankingOptions: + properties: + ranker: + anyOf: + - type: string + - type: 'null' + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + type: object + title: SearchRankingOptions + description: Options for ranking and filtering search results. + V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + benchmark_config: + $ref: '#/components/schemas/BenchmarkConfig' + type: object + required: + - input_rows + - scoring_functions + - benchmark_config + title: V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest + V1AlphaInferenceRerankPostRequest: + properties: + model: + type: string + title: Model + query: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + items: + items: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + type: array + title: Items + max_num_results: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - model + - query + - items + title: V1AlphaInferenceRerankPostRequest + V1AlphaPostTrainingPreferenceOptimizePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + finetuned_model: + type: string + title: Finetuned Model + algorithm_config: + $ref: '#/components/schemas/DPOAlignmentConfig' + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + type: object + required: + - job_uuid + - finetuned_model + - algorithm_config + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingPreferenceOptimizePostRequest + V1AlphaPostTrainingSupervisedFineTunePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + model: + anyOf: + - type: string + - type: 'null' + description: Model descriptor for training if not in provider config` + checkpoint_dir: + anyOf: + - type: string + - type: 'null' + algorithm_config: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LoraFinetuningConfig' + title: LoraFinetuningConfig + - $ref: '#/components/schemas/QATFinetuningConfig' + title: QATFinetuningConfig + discriminator: + propertyName: type + mapping: + LoRA: '#/components/schemas/LoraFinetuningConfig' + QAT: '#/components/schemas/QATFinetuningConfig' + title: LoraFinetuningConfig | QATFinetuningConfig + - type: 'null' + title: Algorithm Config + type: object + required: + - job_uuid + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingSupervisedFineTunePostRequest _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 + title: _URLOrData + description: A URL or a base64 encoded string SamplingStrategy: discriminator: mapping: @@ -7336,99 +7900,6 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat - 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 - 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 - 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 - 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 OpenAIResponseContentPart: discriminator: mapping: @@ -7444,56 +7915,6 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText - 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 - 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 SpanEndPayload: description: Payload for a span end event. properties: @@ -7715,110 +8136,6 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - 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 ImageDelta: description: An image content delta for streaming responses. properties: @@ -7850,16 +8167,6 @@ components: - text title: TextDelta type: object - JobStatus: - description: Status of a job execution. - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - type: string MetricInResponse: description: A metric value included in API responses. properties: @@ -7975,14 +8282,6 @@ components: - 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 Api: description: Enumeration of all available APIs in the Llama Stack system. enum: @@ -8311,26 +8610,6 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig 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 OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -8501,13 +8780,6 @@ components: - content title: UserMessage type: object - HealthStatus: - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - type: string PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -8688,3 +8960,131 @@ components: - query title: VectorStoreSearchRequest type: object + 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' +tags: +- description: APIs for creating and interacting with agentic systems. + name: Agents + x-displayName: Agents +- description: |- + The API is designed to allow use of openai client libraries for seamless integration. + + This API provides the following extensions: + - idempotent batch creation + + Note: This API is currently under active development and may undergo changes. + name: Batches + x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale. +- description: '' + name: Benchmarks +- description: Protocol for conversation management operations. + name: Conversations + x-displayName: Conversations +- description: '' + name: DatasetIO +- description: '' + name: Datasets +- description: Llama Stack Evaluation API for running evaluations on model and agent candidates. + name: Eval + x-displayName: Evaluations +- description: This API is used to upload documents that can be used with other Llama Stack APIs. + name: Files + x-displayName: Files +- description: |- + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Three kinds of models are supported: + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. + - Rerank models: these models reorder the documents based on their relevance to a query. + name: Inference + x-displayName: Inference +- description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers. + name: Inspect + x-displayName: Inspect +- description: '' + name: Models +- description: '' + name: PostTraining (Coming Soon) +- description: Protocol for prompt management operations. + name: Prompts + x-displayName: Prompts +- description: Providers API for inspecting, listing, and modifying providers and their configurations. + name: Providers + x-displayName: Providers +- description: OpenAI-compatible Moderations API. + name: Safety + x-displayName: Safety +- description: '' + name: Scoring +- description: '' + name: ScoringFunctions +- description: '' + name: Shields +- description: '' + name: ToolGroups +- description: '' + name: ToolRuntime +- description: '' + name: VectorIO +x-tagGroups: +- name: Operations + tags: + - Agents + - Batches + - Benchmarks + - Conversations + - DatasetIO + - Datasets + - Eval + - Files + - Inference + - Inspect + - Models + - PostTraining (Coming Soon) + - Prompts + - Providers + - Safety + - Scoring + - ScoringFunctions + - Shields + - ToolGroups + - ToolRuntime + - VectorIO +security: +- Default: [] diff --git a/docs/static/llama-stack-spec.yaml b/docs/static/llama-stack-spec.yaml index b4d16eaed..f9872e42b 100644 --- a/docs/static/llama-stack-spec.yaml +++ b/docs/static/llama-stack-spec.yaml @@ -14,39 +14,86 @@ servers: paths: /v1/batches: get: + responses: + '200': + description: A list of batch objects. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBatchesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Batches summary: List Batches + description: List all batches for the current user. operationId: list_batches_v1_batches_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + type: integer + default: 20 + title: Limit + post: responses: '200': - description: Successful Response + description: The created batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Batches summary: Create Batch + description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BatchesPostRequest' + /v1/batches/{batch_id}: + get: responses: '200': - description: Successful Response + description: The batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -59,30 +106,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/batches/{batch_id}: - get: tags: - Batches summary: Retrieve Batch + description: Retrieve information about a specific 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 @@ -92,16 +120,13 @@ paths: description: 'Path parameter: batch_id' /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 + description: The updated batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -114,6 +139,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Batches + summary: Cancel Batch + description: Cancel a batch that is in progress. + operationId: cancel_batch_v1_batches__batch_id__cancel_post parameters: - name: batch_id in: path @@ -123,39 +153,111 @@ paths: description: 'Path parameter: batch_id' /v1/chat/completions: get: + responses: + '200': + description: A ListOpenAIChatCompletionResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Inference summary: List Chat Completions + description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: model + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Model + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: An OpenAIChatCompletion. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIChatCompletion' + text/event-stream: + schema: + $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Inference summary: Openai Chat Completion + description: |- + Create chat completions. + + Generate an OpenAI-compatible chat completion for the given messages using the specified model. operationId: openai_chat_completion_v1_chat_completions_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' + /v1/chat/completions/{completion_id}: + get: responses: '200': - description: Successful Response + description: A OpenAICompletionWithInputMessages. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -168,30 +270,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/chat/completions/{completion_id}: - get: tags: - Inference summary: Get Chat Completion + description: |- + Get chat completion. + + Describe a chat completion by its ID. 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 @@ -201,16 +287,48 @@ paths: description: 'Path parameter: completion_id' /v1/completions: post: + responses: + '200': + description: An OpenAICompletion. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICompletion' + '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' tags: - Inference summary: Openai Completion + description: |- + Create completion. + + Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' + required: true + /v1/conversations: + post: responses: '200': - description: Successful Response + description: The created conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -223,18 +341,29 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/conversations: - post: tags: - Conversations summary: Create Conversation + description: |- + Create a conversation. + + Create a conversation. operationId: create_conversation_v1_conversations_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsPostRequest' + required: true + /v1/conversations/{conversation_id}: + get: responses: '200': - description: Successful Response + description: The conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -247,30 +376,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/conversations/{conversation_id}: - get: tags: - Conversations summary: Get Conversation + description: |- + Retrieve a conversation. + + Get a conversation with the given ID. 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 @@ -279,16 +392,13 @@ paths: 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 + description: The updated conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -301,6 +411,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Update Conversation + description: |- + Update a conversation. + + Update a conversation's metadata with the given ID. + operationId: update_conversation_v1_conversations__conversation_id__post parameters: - name: conversation_id in: path @@ -308,17 +426,20 @@ paths: schema: type: string description: 'Path parameter: conversation_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsByConversationIdPostRequest' + required: true delete: - tags: - - Conversations - summary: Openai Delete Conversation - operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': - description: Successful Response + description: The deleted conversation resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ConversationDeletedResource' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -331,6 +452,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Openai Delete Conversation + description: |- + Delete a conversation. + + Delete a conversation with the given ID. + operationId: openai_delete_conversation_v1_conversations__conversation_id__delete parameters: - name: conversation_id in: path @@ -340,58 +469,105 @@ paths: description: 'Path parameter: conversation_id' /v1/conversations/{conversation_id}/items: get: + responses: + '200': + description: List of conversation items. + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationItemList' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Conversations summary: List Items + description: |- + List items. + + List items in the conversation. 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - enum: + - asc + - desc + type: string + - type: 'null' + title: Order - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' + - name: include + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/ConversationItemInclude' + - type: 'null' + title: Include post: + responses: + '200': + description: List of created items. + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationItemList' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Conversations summary: Add Items + description: |- + Create items. + + Create items in the conversation. 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 @@ -399,18 +575,21 @@ paths: schema: type: string description: 'Path parameter: conversation_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsByConversationIdItemsPostRequest' /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 + description: The conversation item. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseMessage' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -423,6 +602,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Retrieve + description: |- + Retrieve an item. + + Retrieve a conversation item. + operationId: retrieve_v1_conversations__conversation_id__items__item_id__get parameters: - name: conversation_id in: path @@ -437,16 +624,13 @@ paths: 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 + description: The deleted item resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ConversationItemDeletedResource' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -459,6 +643,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Openai Delete Conversation Item + description: |- + Delete an item. + + Delete a conversation item. + operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete parameters: - name: conversation_id in: path @@ -474,63 +666,151 @@ paths: description: 'Path parameter: item_id' /v1/embeddings: post: + responses: + '200': + description: An OpenAIEmbeddingsResponse containing the embeddings. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIEmbeddingsResponse' + '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' tags: - Inference summary: Openai Embeddings + description: |- + Create embeddings. + + Generate OpenAI-compatible embeddings for the given input using the specified model. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' + required: true /v1/files: get: + responses: + '200': + description: An ListOpenAIFileResponse containing the list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIFileResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Files summary: Openai List Files + description: |- + List files. + + Returns a list of files that belong to the user's organization. operationId: openai_list_files_v1_files_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 10000 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + - name: purpose + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/OpenAIFilePurpose' + - type: 'null' + title: Purpose + post: responses: '200': - description: Successful Response + description: An OpenAIFileObject representing the uploaded file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileObject' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Files summary: Openai Upload File + description: |- + Upload file. + + Upload a file that can be used across various endpoints. + + The file upload should be a multipart form request with: + - file: The File object (not file name) to be uploaded. + - purpose: The intended purpose of the uploaded file. + - expires_after: Optional form values describing expiration for the file. operationId: openai_upload_file_v1_files_post + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Body_openai_upload_file_v1_files_post' + /v1/files/{file_id}: + get: responses: '200': - description: Successful Response + description: An OpenAIFileObject containing file information. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -543,30 +823,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/files/{file_id}: - get: tags: - Files summary: Openai Retrieve File + description: |- + Retrieve file. + + Returns information about a specific 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 @@ -575,16 +839,13 @@ paths: 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 + description: An OpenAIFileDeleteResponse indicating successful deletion. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -597,6 +858,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Files + summary: Openai Delete File + description: Delete file. + operationId: openai_delete_file_v1_files__file_id__delete parameters: - name: file_id in: path @@ -606,16 +872,13 @@ paths: description: 'Path parameter: file_id' /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 + description: The raw file content as a binary response. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Response' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -628,6 +891,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Files + summary: Openai Retrieve File Content + description: |- + Retrieve file content. + + Returns the contents of the specified file. + operationId: openai_retrieve_file_content_v1_files__file_id__content_get parameters: - name: file_id in: path @@ -637,40 +908,85 @@ paths: description: 'Path parameter: file_id' /v1/health: get: + responses: + '200': + description: Health information indicating if the service is operational. + content: + application/json: + schema: + $ref: '#/components/schemas/HealthInfo' + '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' tags: - Inspect summary: Health + description: |- + Get health status. + + Get the current health status of the service. 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: + responses: + '200': + description: Response containing information about all available routes. + content: + application/json: + schema: + $ref: '#/components/schemas/ListRoutesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Inspect summary: List Routes + description: |- + List routes. + + List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get + parameters: + - name: api_filter + in: query + required: false + schema: + anyOf: + - enum: + - v1 + - v1alpha + - v1beta + - deprecated + type: string + - type: 'null' + title: Api Filter + /v1/models: + get: responses: '200': - description: Successful Response + description: A OpenAIListModelsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIListModelsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -683,18 +999,20 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/models: - get: tags: - Models summary: Openai List Models + description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get + /v1/models/{model_id}: + get: responses: '200': - description: Successful Response + description: A Model. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Model' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -707,30 +1025,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/models/{model_id}: - get: tags: - Models summary: Get Model + description: |- + Get model. + + Get a model by its identifier. 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 @@ -740,16 +1042,48 @@ paths: description: 'Path parameter: model_id' /v1/moderations: post: + responses: + '200': + description: A moderation object. + content: + application/json: + schema: + $ref: '#/components/schemas/ModerationObject' + '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' tags: - Safety summary: Run Moderation + description: |- + Create moderation. + + Classifies if text and/or image inputs are potentially harmful. operationId: run_moderation_v1_moderations_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModerationsPostRequest' + required: true + /v1/prompts: + get: responses: '200': - description: Successful Response + description: A ListPromptsResponse containing all prompts. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -762,18 +1096,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/prompts: - get: tags: - Prompts summary: List Prompts + description: List all prompts. operationId: list_prompts_v1_prompts_get + post: responses: '200': - description: Successful Response + description: The created Prompt resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -786,54 +1121,58 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Prompts summary: Create Prompt + description: |- + Create prompt. + + Create a new 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsPostRequest' + required: true /v1/prompts/{prompt_id}: get: + responses: + '200': + description: A Prompt resource. + content: + application/json: + schema: + $ref: '#/components/schemas/Prompt' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Prompts summary: Get Prompt + description: |- + Get prompt. + + Get a prompt by its identifier and optional version. 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: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version - name: prompt_id in: path required: true @@ -841,28 +1180,33 @@ paths: type: string description: 'Path parameter: prompt_id' post: + responses: + '200': + description: The updated Prompt resource with incremented version. + content: + application/json: + schema: + $ref: '#/components/schemas/Prompt' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Prompts summary: Update Prompt + description: |- + Update prompt. + + Update an existing prompt (increments version). 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 @@ -870,11 +1214,13 @@ paths: schema: type: string description: 'Path parameter: prompt_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsByPromptIdPostRequest' delete: - tags: - - Prompts - summary: Delete Prompt - operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': description: Successful Response @@ -882,17 +1228,25 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' + description: Default Response + tags: + - Prompts + summary: Delete Prompt + description: |- + Delete prompt. + + Delete a prompt. + operationId: delete_prompt_v1_prompts__prompt_id__delete parameters: - name: prompt_id in: path @@ -902,16 +1256,13 @@ paths: 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 + description: The prompt with the specified version now set as default. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -924,6 +1275,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Prompts + summary: Set Default Version + description: |- + Set prompt version. + + Set which version of a prompt should be the default in get_prompt (latest). + operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post parameters: - name: prompt_id in: path @@ -931,18 +1290,21 @@ paths: schema: type: string description: 'Path parameter: prompt_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsByPromptIdSetDefaultVersionPostRequest' + required: true /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 + description: A ListPromptsResponse containing all versions of the prompt. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -955,6 +1317,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Prompts + summary: List Prompt Versions + description: |- + List prompt versions. + + List all versions of a specific prompt. + operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get parameters: - name: prompt_id in: path @@ -964,16 +1334,42 @@ paths: description: 'Path parameter: prompt_id' /v1/providers: get: + responses: + '200': + description: A ListProvidersResponse containing information about all providers. + content: + application/json: + schema: + $ref: '#/components/schemas/ListProvidersResponse' + '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' tags: - Providers summary: List Providers + description: |- + List providers. + + List all available providers. operationId: list_providers_v1_providers_get + /v1/providers/{provider_id}: + get: responses: '200': - description: Successful Response + description: A ProviderInfo object containing the provider's details. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ProviderInfo' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -986,30 +1382,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/providers/{provider_id}: - get: tags: - Providers summary: Inspect Provider + description: |- + Get provider. + + Get detailed information about a specific 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 @@ -1019,39 +1399,132 @@ paths: description: 'Path parameter: provider_id' /v1/responses: get: + responses: + '200': + description: A ListOpenAIResponseObject. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIResponseObject' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Agents summary: List Openai Responses + description: List all responses. operationId: list_openai_responses_v1_responses_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 50 + title: Limit + - name: model + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Model + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: An OpenAIResponseObject. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseObject' + text/event-stream: + schema: + $ref: '#/components/schemas/OpenAIResponseObjectStream' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Agents summary: Create Openai Response + description: Create a model response. operationId: create_openai_response_v1_responses_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ResponsesPostRequest' + x-llama-stack-extra-body-params: + guardrails: + $defs: + ResponseGuardrailSpec: + description: |- + Specification for a guardrail to apply during response generation. + + :param type: The type/identifier of the guardrail. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + anyOf: + - items: + anyOf: + - type: string + - $ref: '#/components/schemas/ResponseGuardrailSpec' + type: array + - type: 'null' + description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation. + /v1/responses/{response_id}: + get: responses: '200': - description: Successful Response + description: An OpenAIResponseObject. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1064,30 +1537,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/responses/{response_id}: - get: tags: - Agents summary: Get Openai Response + description: Get a model 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 @@ -1096,16 +1550,13 @@ paths: 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 + description: An OpenAIDeleteResponseObject content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIDeleteResponseObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1118,6 +1569,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Agents + summary: Delete Openai Response + description: Delete a response. + operationId: delete_openai_response_v1_responses__response_id__delete parameters: - name: response_id in: path @@ -1127,71 +1583,151 @@ paths: description: 'Path parameter: response_id' /v1/responses/{response_id}/input_items: get: + responses: + '200': + description: An ListOpenAIResponseInputItem. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIResponseInputItem' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Agents summary: List Openai Response Input Items + description: List 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' + - name: include + in: query + required: false + schema: + anyOf: + - type: array + items: + type: string + - type: 'null' + title: Include /v1/safety/run-shield: post: + responses: + '200': + description: A RunShieldResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/RunShieldResponse' + '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' tags: - Safety summary: Run Shield + description: |- + Run shield. + + Run a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SafetyRunShieldPostRequest' + required: true /v1/scoring-functions: get: + responses: + '200': + description: A ListScoringFunctionsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListScoringFunctionsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Scoring Functions summary: List Scoring Functions + description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get + /v1/scoring-functions/{scoring_fn_id}: + get: responses: '200': - description: Successful Response + description: A ScoringFn. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ScoringFn' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1204,30 +1740,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/scoring-functions/{scoring_fn_id}: - get: tags: - Scoring Functions summary: Get Scoring Function + description: Get a scoring function by its ID. 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 @@ -1237,16 +1754,45 @@ paths: description: 'Path parameter: scoring_fn_id' /v1/scoring/score: post: + responses: + '200': + description: A ScoreResponse object containing rows and aggregated results. + content: + application/json: + schema: + $ref: '#/components/schemas/ScoreResponse' + '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' tags: - Scoring summary: Score + description: Score a list of rows. operationId: score_v1_scoring_score_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringScorePostRequest' + required: true + /v1/scoring/score-batch: + post: responses: '200': - description: Successful Response + description: A ScoreBatchResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ScoreBatchResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1259,18 +1805,26 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/scoring/score-batch: - post: tags: - Scoring summary: Score Batch + description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringScoreBatchPostRequest' + required: true + /v1/shields: + get: responses: '200': - description: Successful Response + description: A ListShieldsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListShieldsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1283,18 +1837,20 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/shields: - get: tags: - Shields summary: List Shields + description: List all shields. operationId: list_shields_v1_shields_get + /v1/shields/{identifier}: + get: responses: '200': - description: Successful Response + description: A Shield. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Shield' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1307,30 +1863,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/shields/{identifier}: - get: tags: - Shields summary: Get Shield + description: Get a shield by its identifier. 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 @@ -1340,64 +1877,122 @@ paths: description: 'Path parameter: identifier' /v1/tool-runtime/invoke: post: + responses: + '200': + description: A ToolInvocationResult. + content: + application/json: + schema: + $ref: '#/components/schemas/ToolInvocationResult' + '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' tags: - Tool Runtime summary: Invoke Tool + description: Run a tool with the given arguments. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ToolRuntimeInvokePostRequest' + required: true /v1/tool-runtime/list-tools: get: + responses: + '200': + description: A ListToolDefsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolDefsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Runtime summary: List Runtime Tools + description: List all tools in the runtime. 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' + parameters: + - name: authorization + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + - name: tool_group_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Tool Group Id + - name: mcp_endpoint + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/URL' + - type: 'null' + title: Mcp Endpoint /v1/toolgroups: get: + responses: + '200': + description: A ListToolGroupsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolGroupsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tool Groups + description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get + /v1/toolgroups/{toolgroup_id}: + get: responses: '200': - description: Successful Response + description: A ToolGroup. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ToolGroup' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1410,30 +2005,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/toolgroups/{toolgroup_id}: - get: tags: - Tool Groups summary: Get Tool Group + description: Get a tool group by its ID. 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 @@ -1443,16 +2019,48 @@ paths: description: 'Path parameter: toolgroup_id' /v1/tools: get: + responses: + '200': + description: A ListToolDefsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolDefsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tools + description: List tools with optional tool group. operationId: list_tools_v1_tools_get + parameters: + - name: toolgroup_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Toolgroup Id + /v1/tools/{tool_name}: + get: responses: '200': - description: Successful Response + description: A ToolDef. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ToolDef' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1465,30 +2073,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/tools/{tool_name}: - get: tags: - Tool Groups summary: Get Tool + description: Get a tool by its name. 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 @@ -1498,16 +2087,47 @@ paths: description: 'Path parameter: tool_name' /v1/vector-io/insert: post: + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Insert Chunks + description: Insert chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Chunk-Input' + title: Chunks + /v1/vector-io/query: + post: responses: '200': - description: Successful Response + description: A QueryChunksResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/QueryChunksResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1520,65 +2140,121 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/vector-io/query: - post: tags: - Vector Io summary: Query Chunks + description: Query chunks from a vector database. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorIoQueryPostRequest' + required: true /v1/vector_stores: get: + responses: + '200': + description: A VectorStoreListResponse containing the list of vector stores. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreListResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Vector Stores + description: Returns a list of vector stores. operationId: openai_list_vector_stores_v1_vector_stores_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: A VectorStoreObject representing the created vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Vector Io summary: Openai Create Vector Store + description: |- + Creates a vector store. + + Generate an OpenAI-compatible vector store with the given parameters. operationId: openai_create_vector_store_v1_vector_stores_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' + /v1/vector_stores/{vector_store_id}: + get: responses: '200': - description: Successful Response + description: A VectorStoreObject representing the vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1591,30 +2267,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/vector_stores/{vector_store_id}: - get: tags: - Vector Io summary: Openai Retrieve Vector Store + description: Retrieves a 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 @@ -1623,16 +2280,13 @@ paths: 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 + description: A VectorStoreObject representing the updated vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1645,6 +2299,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Update Vector Store + description: Updates a vector store. + operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post parameters: - name: vector_store_id in: path @@ -1652,17 +2311,20 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdPostRequest' + required: true 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 + description: A VectorStoreDeleteResponse indicating the deletion status. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1675,6 +2337,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Delete Vector Store + description: Delete a vector store. + operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete parameters: - name: vector_store_id in: path @@ -1684,16 +2351,13 @@ paths: description: 'Path parameter: vector_store_id' /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 + description: A VectorStoreFileBatchObject representing the created file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1706,6 +2370,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Create Vector Store File Batch + description: |- + Create a vector store file batch. + + Generate an OpenAI-compatible vector store file batch for the given vector store. + operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post parameters: - name: vector_store_id in: path @@ -1713,18 +2385,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' + required: true /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 + description: A VectorStoreFileBatchObject representing the file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1737,6 +2412,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Retrieve Vector Store File Batch + description: Retrieve a vector store file batch. + operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get parameters: - name: vector_store_id in: path @@ -1752,16 +2432,13 @@ paths: description: 'Path parameter: batch_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 + description: A VectorStoreFileBatchObject representing the cancelled file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1774,6 +2451,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Cancel Vector Store File Batch + description: Cancels a vector store file batch. + operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post parameters: - name: vector_store_id in: path @@ -1789,29 +2471,73 @@ paths: description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files: get: + responses: + '200': + description: A VectorStoreFilesListInBatchResponse containing the list of files in the batch. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Files In Vector Store File Batch + description: Returns a list of vector store files in a 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: filter + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Filter + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order - name: vector_store_id in: path required: true @@ -1826,29 +2552,78 @@ paths: description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/files: get: + responses: + '200': + description: A VectorStoreListFilesResponse containing the list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreListFilesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Files In Vector Store + description: List files in a 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: filter + in: query + required: false + schema: + title: Filter + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + nullable: true + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order - name: vector_store_id in: path required: true @@ -1856,28 +2631,30 @@ paths: type: string description: 'Path parameter: vector_store_id' post: + responses: + '200': + description: A VectorStoreFileObject representing the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileObject' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai Attach File To Vector Store + description: Attach a file to a 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 @@ -1885,18 +2662,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdFilesPostRequest' /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 + description: A VectorStoreFileObject representing the file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1909,6 +2689,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Retrieve Vector Store File + description: Retrieves a vector store file. + operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get parameters: - name: vector_store_id in: path @@ -1923,16 +2708,13 @@ paths: 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 + description: A VectorStoreFileObject representing the updated file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1945,6 +2727,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Update Vector Store File + description: Updates a vector store file. + operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post parameters: - name: vector_store_id in: path @@ -1958,17 +2745,20 @@ paths: schema: type: string description: 'Path parameter: file_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdFilesByFileIdPostRequest' + required: true 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 + description: A VectorStoreFileDeleteResponse indicating the deletion status. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1981,6 +2771,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Delete Vector Store File + description: Delete a vector store file. + operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete parameters: - name: vector_store_id in: path @@ -1996,29 +2791,49 @@ paths: description: 'Path parameter: file_id' /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: + responses: + '200': + description: File contents, optionally with embeddings and metadata based on query parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileContentResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai Retrieve Vector Store File Contents + description: Retrieves the contents of a vector store file. 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: include_embeddings + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + default: false + title: Include Embeddings + - name: include_metadata + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + default: false + title: Include Metadata - name: vector_store_id in: path required: true @@ -2033,16 +2848,13 @@ paths: 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 + description: A VectorStoreSearchResponse containing the search results. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreSearchResponsePage' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2055,6 +2867,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Search Vector Store + description: |- + Search for chunks in a vector store. + + Searches a vector store for relevant chunks based on a query and optional file attribute filters. + operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post parameters: - name: vector_store_id in: path @@ -2062,18 +2882,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdSearchPostRequest' + required: true /v1/version: get: - tags: - - Inspect - summary: Version - operationId: version_v1_version_get responses: '200': - description: Successful Response + description: Version information containing the service version number. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VersionInfo' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2086,44 +2909,15 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Inspect + summary: Version + description: |- + Get version. + + Get the version of the service. + operationId: version_v1_version_get 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: Error: description: Error response from the API. Roughly follows RFC 7807. @@ -2149,63 +2943,61 @@ components: title: Error type: object ListBatchesResponse: - description: Response containing a list of batch objects. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: - description: List of batch objects items: $ref: '#/components/schemas/Batch' - title: Data type: array + title: Data + description: List of batch objects 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 + title: Has More + description: Whether there are more batches available + default: false + type: object required: - data title: ListBatchesResponse - type: object + description: Response containing a list of batch objects. Batch: - additionalProperties: true properties: id: + type: string title: Id - type: string completion_window: + type: string title: Completion Window - type: string created_at: - title: Created At type: integer + title: Created At endpoint: + type: string title: Endpoint - type: string input_file_id: - title: Input File Id type: string + title: Input File Id object: + type: string const: batch title: Object - type: string status: + type: string enum: - validating - failed @@ -2216,90 +3008,76 @@ components: - 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 + additionalProperties: true + type: object required: - id - completion_window @@ -2309,36 +3087,42 @@ components: - object - status title: Batch - type: object + Order: + type: string + enum: + - asc + - desc + title: Order + description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: - description: Response from listing OpenAI-compatible chat completions. properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse - type: object + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: @@ -2372,19 +3156,19 @@ components: title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionContentPartImageParam: - description: Image content part for OpenAI-compatible chat completion messages. properties: type: - const: image_url - default: image_url - title: Type type: string + const: image_url + title: Type + default: image_url image_url: $ref: '#/components/schemas/OpenAIImageURL' + type: object required: - image_url title: OpenAIChatCompletionContentPartImageParam - type: object + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -2401,139 +3185,130 @@ components: title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIChatCompletionContentPartTextParam: - description: Text content part for OpenAI-compatible chat completion messages. properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: OpenAIChatCompletionContentPartTextParam - type: object + description: Text content part for OpenAI-compatible chat completion messages. 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 + const: function + title: Type + default: function function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' - nullable: true title: OpenAIChatCompletionToolCallFunction - title: OpenAIChatCompletionToolCall type: object + title: OpenAIChatCompletionToolCall + description: Tool call specification for OpenAI-compatible chat completion responses. 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 + title: OpenAIChatCompletionToolCallFunction + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: - description: Usage information for OpenAI chat completion. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer completion_tokens: + type: integer title: Completion Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage - type: object + description: Usage information for OpenAI chat completion. 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + title: OpenAIUserMessageParam-Output | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' finish_reason: - title: Finish Reason type: string + title: Finish Reason index: - title: Index type: integer + title: Index logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' - nullable: true title: OpenAIChoiceLogprobs + type: object required: - message - finish_reason - index title: OpenAIChoice - type: object + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. properties: content: anyOf: @@ -2541,24 +3316,22 @@ components: $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 + title: OpenAIChoiceLogprobs + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: - description: A message from the developer in an OpenAI-compatible chat completion request. properties: role: - const: developer - default: developer - title: Role type: string + const: developer + title: Role + default: developer content: anyOf: - type: string @@ -2571,58 +3344,54 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAIDeveloperMessageParam - type: object + description: A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: properties: type: - const: file - default: file - title: Type type: string + const: file + title: Type + default: file file: $ref: '#/components/schemas/OpenAIFileFile' + type: object 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 + title: OpenAIFileFile OpenAIImageURL: - description: Image URL specification for OpenAI-compatible chat completion messages. properties: url: - title: Url type: string + title: Url detail: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - url title: OpenAIImageURL - type: object + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: discriminator: mapping: @@ -2645,13 +3414,12 @@ components: title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAISystemMessageParam: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string @@ -2664,12 +3432,36 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAISystemMessageParam - type: object + description: A system message providing instructions or context to the model. OpenAITokenLogProb: + properties: + token: + type: string + title: Token + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + logprob: + type: number + title: Logprob + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + type: array + title: Top Logprobs + type: object + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb description: |- The log probability for a token from an OpenAI-compatible chat completion response. @@ -2677,42 +3469,16 @@ components: :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 OpenAIToolMessageParam: - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. properties: role: + type: string const: tool - default: tool title: Role - type: string + default: tool tool_call_id: - title: Tool Call Id type: string + title: Tool Call Id content: anyOf: - type: string @@ -2721,37 +3487,37 @@ components: type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] + type: object required: - tool_call_id - content title: OpenAIToolMessageParam - type: object + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. 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 + title: Token bytes: anyOf: - items: type: integer type: array - type: 'null' - nullable: true logprob: - title: Logprob type: number + title: Logprob + type: object required: - token - logprob title: OpenAITopLogProb - type: object + 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 OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -2791,11 +3557,10 @@ components: title: OpenAIUserMessageParam type: object OpenAIJSONSchema: - description: JSON schema specification for OpenAI-compatible structured response format. properties: name: - title: Name type: string + title: Name description: anyOf: - type: string @@ -2809,32 +3574,33 @@ components: - additionalProperties: true type: object - type: 'null' + type: object title: OpenAIJSONSchema - type: object + description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: - description: JSON object response format for OpenAI-compatible chat completion requests. properties: type: + type: string const: json_object - default: json_object title: Type - type: string - title: OpenAIResponseFormatJSONObject + default: json_object type: object + title: OpenAIResponseFormatJSONObject + description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: - description: JSON schema response format for OpenAI-compatible chat completion requests. properties: type: - const: json_schema - default: json_schema - title: Type type: string + const: json_schema + title: Type + default: json_schema json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' + type: object required: - json_schema title: OpenAIResponseFormatJSONSchema - type: object + description: JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: discriminator: mapping: @@ -2851,52 +3617,49 @@ components: title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject OpenAIResponseFormatText: - description: Text response format for OpenAI-compatible chat completion requests. properties: type: - const: text - default: text - title: Type type: string - title: OpenAIResponseFormatText + const: text + title: Type + default: text type: object + title: OpenAIResponseFormatText + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible chat completion endpoint. properties: model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array minItems: 1 title: Messages - type: array frequency_penalty: anyOf: - type: number - type: 'null' - nullable: true function_call: anyOf: - type: string @@ -2904,7 +3667,6 @@ components: type: object - type: 'null' title: string | object - nullable: true functions: anyOf: - items: @@ -2912,68 +3674,58 @@ components: 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: + - oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject + discriminator: + propertyName: type + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format - nullable: true seed: anyOf: - type: integer - type: 'null' - nullable: true stop: anyOf: - type: string @@ -2983,23 +3735,19 @@ components: 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 @@ -3007,7 +3755,6 @@ components: type: object - type: 'null' title: string | object - nullable: true tools: anyOf: - items: @@ -3015,63 +3762,60 @@ components: 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 + additionalProperties: true + type: object required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: - description: Response from an OpenAI-compatible chat completion request. properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' - nullable: true title: OpenAIChatCompletionUsage + type: object required: - id - choices - created - model title: OpenAIChatCompletion - type: object + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: @@ -3167,55 +3911,55 @@ components: OpenAICompletionWithInputMessages: properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Input Messages + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output | ... (5 variants) type: array + title: Input Messages + type: object required: - id - choices @@ -3223,14 +3967,11 @@ components: - model - input_messages title: OpenAICompletionWithInputMessages - type: object OpenAICompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible completion endpoint. properties: model: - title: Model type: string + title: Model prompt: anyOf: - type: string @@ -3253,49 +3994,40 @@ components: 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 @@ -3305,44 +4037,66 @@ components: 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 + additionalProperties: true + type: object required: - model - prompt title: OpenAICompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: + properties: + id: + type: string + title: Id + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + type: array + title: Choices + created: + type: integer + title: Created + model: + type: string + title: Model + object: + type: string + const: text_completion + title: Object + default: text_completion + type: object + required: + - id + - choices + - created + - model + title: OpenAICompletion description: |- Response from an OpenAI-compatible completion request. @@ -3351,34 +4105,29 @@ components: :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 OpenAICompletionChoice: + properties: + finish_reason: + type: string + title: Finish Reason + text: + type: string + title: Text + index: + type: integer + title: Index + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + title: OpenAIChoiceLogprobs + type: object + required: + - finish_reason + - text + - index + title: OpenAICompletionChoice description: |- A choice from an OpenAI-compatible completion response. @@ -3386,29 +4135,6 @@ components: :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 ConversationItem: discriminator: mapping: @@ -3443,54 +4169,55 @@ components: title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) OpenAIResponseAnnotationCitation: - description: URL citation annotation for referencing external web resources. properties: type: + type: string const: url_citation - default: url_citation title: Type - type: string + default: url_citation end_index: + type: integer title: End Index - type: integer start_index: - title: Start Index type: integer + title: Start Index title: + type: string title: Title - type: string url: - title: Url type: string + title: Url + type: object required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation - type: object + description: URL citation annotation for referencing external web resources. OpenAIResponseAnnotationContainerFileCitation: properties: type: + type: string const: container_file_citation - default: container_file_citation title: Type - type: string + default: container_file_citation container_id: + type: string title: Container Id - type: string end_index: + type: integer title: End Index - type: integer file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename start_index: - title: Start Index type: integer + title: Start Index + type: object required: - container_id - end_index @@ -3498,48 +4225,47 @@ components: - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation - type: object OpenAIResponseAnnotationFileCitation: - description: File citation annotation for referencing specific files in response content. properties: type: + type: string const: file_citation - default: file_citation title: Type - type: string + default: file_citation file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename index: - title: Index type: integer + title: Index + type: object required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation - type: object + description: File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: properties: type: + type: string const: file_path - default: file_path title: Type - type: string + default: file_path file_id: - title: File Id type: string + title: File Id index: - title: Index type: integer + title: Index + type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath - type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -3559,49 +4285,47 @@ components: title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: - description: Refusal content within a streamed response part. properties: type: + type: string const: refusal - default: refusal title: Type - type: string + default: refusal refusal: - title: Refusal type: string + title: Refusal + type: object required: - refusal title: OpenAIResponseContentPartRefusal - type: object + description: Refusal content within a streamed response part. OpenAIResponseInputFunctionToolCallOutput: - description: This represents the output of a function call that gets passed back to the model. properties: call_id: + type: string title: Call Id - type: string output: + type: string title: Output - type: string type: - const: function_call_output - default: function_call_output - title: Type type: string + const: function_call_output + title: Type + default: function_call_output id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput - type: object + description: This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: discriminator: mapping: @@ -3618,134 +4342,126 @@ components: title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseInputMessageContentFile: - description: File content for input messages in OpenAI response format. properties: type: - const: input_file - default: input_file - title: Type type: string + const: input_file + title: Type + default: input_file 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 + title: OpenAIResponseInputMessageContentFile + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: - description: Image content for input messages in OpenAI response format. properties: detail: - default: auto title: Detail + default: auto type: string enum: - low - high - auto type: - const: input_image - default: input_image - title: Type type: string + const: input_image + title: Type + default: input_image file_id: anyOf: - type: string - type: 'null' - nullable: true image_url: anyOf: - type: string - type: 'null' - nullable: true - title: OpenAIResponseInputMessageContentImage type: object + title: OpenAIResponseInputMessageContentImage + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: - description: Text content for input messages in OpenAI response format. properties: text: + type: string title: Text - type: string type: - const: input_text - default: input_text - title: Type type: string + const: input_text + title: Type + default: input_text + type: object required: - text title: OpenAIResponseInputMessageContentText - type: object + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: - description: A request for human approval of a tool invocation. properties: arguments: + type: string title: Arguments - type: string id: + type: string title: Id - type: string name: + type: string title: Name - type: string server_label: + type: string title: Server Label - type: string type: - const: mcp_approval_request - default: mcp_approval_request - title: Type type: string + const: mcp_approval_request + title: Type + default: mcp_approval_request + type: object required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest - type: object + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: - description: A response to an MCP approval request. properties: approval_request_id: + type: string title: Approval Request Id - type: string approve: - title: Approve type: boolean + title: Approve type: - const: mcp_approval_response - default: mcp_approval_response - title: Type type: string + const: mcp_approval_response + title: Type + default: mcp_approval_response id: anyOf: - type: string - type: 'null' - nullable: true reason: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse - type: object + description: A response to an MCP approval request. OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -3832,22 +4548,15 @@ components: OpenAIResponseOutputMessageContentOutputText: properties: text: + type: string title: Text - type: string type: - const: output_text - default: output_text - title: Type type: string + const: output_text + title: Type + default: output_text 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 @@ -3857,176 +4566,177 @@ components: title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath + discriminator: + propertyName: type + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - title: Annotations type: array + title: Annotations + type: object required: - text title: OpenAIResponseOutputMessageContentOutputText - type: object OpenAIResponseOutputMessageFileSearchToolCall: - description: File search tool call output message for OpenAI responses. properties: id: - title: Id type: string + title: Id queries: items: type: string - title: Queries type: array + title: Queries status: + type: string title: Status - type: string type: - const: file_search_call - default: file_search_call - title: Type type: string + const: file_search_call + title: Type + default: file_search_call results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' - nullable: true + type: object required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall - type: object + description: File search tool call output message for OpenAI responses. OpenAIResponseOutputMessageFunctionToolCall: - description: Function tool call output message for OpenAI responses. properties: call_id: + type: string title: Call Id - type: string name: + type: string title: Name - type: string arguments: + type: string title: Arguments - type: string type: - const: function_call - default: function_call - title: Type type: string + const: function_call + title: Type + default: function_call id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall - type: object + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: - description: Model Context Protocol (MCP) call output message for OpenAI responses. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_call - default: mcp_call title: Type - type: string + default: mcp_call arguments: + type: string title: Arguments - type: string name: + type: string title: Name - type: string server_label: - title: Server Label type: string + title: Server Label error: anyOf: - type: string - type: 'null' - nullable: true output: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall - type: object + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: - description: MCP list tools output message containing available tools from an MCP server. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_list_tools - default: mcp_list_tools title: Type - type: string + default: mcp_list_tools server_label: - title: Server Label type: string + title: Server Label tools: items: $ref: '#/components/schemas/MCPListToolsTool' - title: Tools type: array + title: Tools + type: object required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools - type: object + description: MCP list tools output message containing available tools from an MCP server. OpenAIResponseOutputMessageWebSearchToolCall: - description: Web search tool call output message for OpenAI responses. properties: id: + type: string title: Id - type: string status: + type: string title: Status - type: string type: - const: web_search_call - default: web_search_call - title: Type type: string + const: web_search_call + title: Type + default: web_search_call + type: object required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall - type: object + description: Web search tool call output message for OpenAI responses. Conversation: - description: OpenAI-compatible conversation object. properties: id: - description: The unique ID of the conversation. + type: string title: Id - type: string + description: The unique ID of the conversation. object: - const: conversation - default: conversation - description: The object type, which is always conversation. - title: Object type: string + const: conversation + title: Object + description: The object type, which is always conversation. + default: conversation created_at: - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - title: Created At type: integer + title: Created At + description: The time at which the conversation was created, measured in seconds since the Unix epoch. metadata: anyOf: - additionalProperties: @@ -4034,7 +4744,6 @@ components: 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: @@ -4043,59 +4752,45 @@ components: 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 + type: object required: - id - created_at title: Conversation - type: object + description: OpenAI-compatible conversation object. ConversationDeletedResource: - description: Response for deleted conversation. properties: id: - description: The deleted conversation identifier + type: string title: Id - type: string + description: The deleted conversation identifier object: - default: conversation.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationDeletedResource - type: object + description: Response for deleted conversation. ConversationItemList: - description: List of conversation items with pagination. properties: object: - default: list - description: Object type - title: Object type: string + title: Object + description: Object type + default: list 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -4112,58 +4807,68 @@ components: title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - title: Data + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (9 variants) type: array + title: Data + description: List of conversation items 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 + title: Has More + description: Whether there are more items available + default: false + type: object required: - data title: ConversationItemList - type: object + description: List of conversation items with pagination. ConversationItemDeletedResource: - description: Response for deleted conversation item. properties: id: - description: The deleted item identifier + type: string title: Id - type: string + description: The deleted item identifier object: - default: conversation.item.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.item.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationItemDeletedResource - type: object + description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible embeddings endpoint. properties: model: - title: Model type: string + title: Model input: anyOf: - type: string @@ -4181,25 +4886,24 @@ components: anyOf: - type: integer - type: 'null' - nullable: true user: anyOf: - type: string - type: 'null' - nullable: true + additionalProperties: true + type: object required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: - description: A single embedding data object from an OpenAI-compatible embeddings response. properties: object: - const: embedding - default: embedding - title: Object type: string + const: embedding + title: Object + default: embedding embedding: anyOf: - items: @@ -4209,112 +4913,113 @@ components: - type: string title: list[number] | string index: - title: Index type: integer + title: Index + type: object required: - embedding - index title: OpenAIEmbeddingData - type: object + description: A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: - description: Usage information for an OpenAI-compatible embeddings response. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens + type: object required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage - type: object + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: - description: Response from an OpenAI-compatible embeddings request. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' - title: Data type: array + title: Data model: - title: Model type: string + title: Model usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' + type: object required: - data - model - usage title: OpenAIEmbeddingsResponse - type: object + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: - description: Valid purpose values for OpenAI Files API. + type: string enum: - assistants - batch title: OpenAIFilePurpose - type: string + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: - description: Response for listing files in OpenAI Files API. properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse - type: object + description: Response for listing files in OpenAI Files API. OpenAIFileObject: - description: OpenAI File object as defined in the OpenAI Files API. properties: object: + type: string const: file - default: file title: Object - type: string + default: file id: + type: string title: Id - type: string bytes: + type: integer title: Bytes - type: integer created_at: + type: integer title: Created At - type: integer expires_at: - title: Expires At type: integer + title: Expires At filename: - title: Filename type: string + title: Filename purpose: $ref: '#/components/schemas/OpenAIFilePurpose' + type: object required: - id - bytes @@ -4323,90 +5028,119 @@ components: - filename - purpose title: OpenAIFileObject - type: object + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: + properties: + anchor: + type: string + const: created_at + title: Anchor + seconds: + type: integer + maximum: 2592000.0 + minimum: 3600.0 + title: Seconds + type: object + required: + - anchor + - seconds + title: 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 OpenAIFileDeleteResponse: - description: Response for deleting a file in OpenAI Files API. properties: id: + type: string title: Id - type: string object: - const: file - default: file - title: Object type: string + const: file + title: Object + default: file deleted: - title: Deleted type: boolean + title: Deleted + type: object required: - id - deleted title: OpenAIFileDeleteResponse + description: Response for deleting a file in OpenAI Files API. + Response: + title: Response type: object HealthInfo: - description: Health status information for the service. properties: status: $ref: '#/components/schemas/HealthStatus' + type: object required: - status title: HealthInfo - type: object + description: Health status information for the service. RouteInfo: - description: Information about an API route including its path, method, and implementing providers. properties: route: + type: string title: Route - type: string method: - title: Method type: string + title: Method provider_types: items: type: string - title: Provider Types type: array + title: Provider Types + type: object required: - route - method - provider_types title: RouteInfo - type: object + description: Information about an API route including its path, method, and implementing providers. ListRoutesResponse: - description: Response containing a list of all available API routes. properties: data: items: $ref: '#/components/schemas/RouteInfo' - title: Data type: array + title: Data + type: object required: - data title: ListRoutesResponse - type: object + description: Response containing a list of all available API routes. OpenAIModel: + properties: + id: + type: string + title: Id + object: + type: string + const: model + title: Object + default: model + created: + type: integer + title: Created + owned_by: + type: string + title: Owned By + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - id + - created + - owned_by + title: OpenAIModel description: |- A model from OpenAI. @@ -4415,120 +5149,90 @@ components: :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 + title: Data + type: object required: - data title: OpenAIListModelsResponse - type: object 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: model - default: model - title: Type type: string + const: model + title: Type + default: model metadata: additionalProperties: true - description: Any additional metadata for this model - title: Metadata type: object + title: Metadata + description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm + type: object required: - identifier - provider_id title: Model - type: object + description: A model resource representing an AI model registered in Llama Stack. ModelType: - description: Enumeration of supported model types in Llama Stack. + type: string enum: - llm - embedding - rerank title: ModelType - type: string + description: Enumeration of supported model types in Llama Stack. ModerationObject: - description: A moderation object. properties: id: + type: string title: Id - type: string model: - title: Model type: string + title: Model results: items: $ref: '#/components/schemas/ModerationObjectResults' - title: Results type: array + title: Results + type: object required: - id - model - results title: ModerationObject - type: object - ModerationObjectResults: description: A moderation object. + ModerationObjectResults: properties: flagged: - title: Flagged type: boolean + title: Flagged categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' - nullable: true category_applied_input_types: anyOf: - additionalProperties: @@ -4537,93 +5241,90 @@ components: 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 + title: Metadata + type: object required: - flagged title: ModerationObjectResults - type: object + description: A moderation 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 + minimum: 1.0 + title: Version + description: Version (integer starting at 1, incremented on save) prompt_id: - description: Unique identifier in format 'pmpt_<48-digit-hash>' - title: Prompt Id type: string + title: Prompt Id + description: Unique identifier in format 'pmpt_<48-digit-hash>' variables: - description: List of variable names that can be used in the prompt template items: type: string - title: Variables type: array + title: Variables + description: List of variable names that can be used in the prompt template is_default: - default: false - description: Boolean indicating whether this version is the default version - title: Is Default type: boolean + title: Is Default + description: Boolean indicating whether this version is the default version + default: false + type: object required: - version - prompt_id title: Prompt - type: object + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. ListPromptsResponse: - description: Response model to list prompts. properties: data: items: $ref: '#/components/schemas/Prompt' - title: Data type: array + title: Data + type: object required: - data title: ListPromptsResponse - type: object + description: Response model to list prompts. ProviderInfo: - description: Information about a registered provider including its configuration and health status. properties: api: + type: string title: Api - type: string provider_id: + type: string title: Provider Id - type: string provider_type: - title: Provider Type type: string + title: Provider Type config: additionalProperties: true - title: Config type: object + title: Config health: additionalProperties: true - title: Health type: object + title: Health + type: object required: - api - provider_id @@ -4631,62 +5332,62 @@ components: - config - health title: ProviderInfo - type: object + description: Information about a registered provider including its configuration and health status. ListProvidersResponse: - description: Response containing a list of all available providers. properties: data: items: $ref: '#/components/schemas/ProviderInfo' - title: Data type: array + title: Data + type: object required: - data title: ListProvidersResponse - type: object + description: Response containing a list of all available providers. ListOpenAIResponseObject: - description: Paginated list of OpenAI response objects with navigation metadata. properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject - type: object + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: - description: Error details for failed OpenAI response requests. properties: code: + type: string title: Code - type: string message: - title: Message type: string + title: Message + type: object required: - code - message title: OpenAIResponseError - type: object + description: Error details for failed OpenAI response requests. OpenAIResponseInput: anyOf: - discriminator: @@ -4723,29 +5424,27 @@ components: title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage OpenAIResponseInputToolFileSearch: - description: File search tool configuration for OpenAI response inputs. properties: type: - const: file_search - default: file_search - title: Type type: string + const: file_search + title: Type + default: file_search vector_store_ids: items: type: string - title: Vector Store Ids type: array + title: Vector Store Ids filters: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true max_num_results: anyOf: - - maximum: 50 - minimum: 1 - type: integer + - type: integer + maximum: 50.0 + minimum: 1.0 - type: 'null' default: 10 ranking_options: @@ -4753,28 +5452,26 @@ components: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' - nullable: true title: SearchRankingOptions + type: object required: - vector_store_ids title: OpenAIResponseInputToolFileSearch - type: object + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: - description: Function tool configuration for OpenAI response inputs. properties: type: + type: string const: function - default: function title: Type - type: string + default: function name: - title: Name type: string + title: Name description: anyOf: - type: string - type: 'null' - nullable: true parameters: anyOf: - additionalProperties: true @@ -4784,18 +5481,17 @@ components: anyOf: - type: boolean - type: 'null' - nullable: true + type: object required: - name - parameters title: OpenAIResponseInputToolFunction - type: object + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: - description: Web search tool configuration for OpenAI response inputs. properties: type: - default: web_search title: Type + default: web_search type: string enum: - web_search @@ -4804,51 +5500,40 @@ components: - web_search_2025_08_26 search_context_size: anyOf: - - pattern: ^low|medium|high$ - type: string + - type: string + pattern: ^low|medium|high$ - type: 'null' default: medium - title: OpenAIResponseInputToolWebSearch type: object + title: OpenAIResponseInputToolWebSearch + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: - description: OpenAI response object extended with input context information. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -4861,33 +5546,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -4897,20 +5589,9 @@ components: 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 @@ -4920,48 +5601,43 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -4974,16 +5650,27 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Input + type: object required: - created_at - id @@ -4992,7 +5679,7 @@ components: - status - input title: OpenAIResponseObjectWithInput - type: object + description: OpenAI response object extended with input context information. OpenAIResponseOutput: discriminator: mapping: @@ -5021,20 +5708,13 @@ components: title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) OpenAIResponsePrompt: - description: OpenAI compatible Prompt object that is used in OpenAI responses. properties: id: - title: Id type: string + title: Id 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 @@ -5042,31 +5722,35 @@ components: title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' - nullable: true version: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id title: OpenAIResponsePrompt - type: object + description: OpenAI compatible Prompt object that is used in OpenAI responses. 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 + title: OpenAIResponseText + description: Text response configuration for OpenAI responses. OpenAIResponseTool: discriminator: mapping: @@ -5089,16 +5773,15 @@ components: title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: - title: Server Label type: string + title: Server Label allowed_tools: anyOf: - items: @@ -5109,43 +5792,41 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label title: OpenAIResponseToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. OpenAIResponseUsage: - description: Usage information for OpenAI response. properties: input_tokens: + type: integer title: Input Tokens - type: integer output_tokens: + type: integer title: Output Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - input_tokens - output_tokens - total_tokens title: OpenAIResponseUsage - type: object + description: Usage information for OpenAI response. ResponseGuardrailSpec: description: Specification for a guardrail to apply during response generation. properties: @@ -5178,40 +5859,37 @@ components: title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseInputToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: + type: string title: Server Label - type: string server_url: - title: Server Url type: string + title: Server Url 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 + - type: string + const: always + - type: string + const: never - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter - default: never title: string | ApprovalFilter + default: never allowed_tools: anyOf: - items: @@ -5222,51 +5900,39 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label - server_url title: OpenAIResponseInputToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseObject: - description: Complete OpenAI response object containing generation results and metadata. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5279,33 +5945,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -5315,20 +5988,9 @@ components: 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 @@ -5338,32 +6000,38 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + type: object required: - created_at - id @@ -5371,7 +6039,7 @@ components: - output - status title: OpenAIResponseObject - type: object + description: Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: @@ -6535,43 +7203,32 @@ components: title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: - description: Response object confirming deletion of an OpenAI response. properties: id: + type: string title: Id - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: OpenAIDeleteResponseObject - type: object + description: Response object confirming deletion of an OpenAI response. 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -6584,39 +7241,48 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Data object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data title: ListOpenAIResponseInputItem - type: object + description: List container for OpenAI response input items. 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 + title: RunShieldResponse + description: Response from running a safety shield. SafetyViolation: - description: Details of a safety violation detected by content moderation. properties: violation_level: $ref: '#/components/schemas/ViolationLevel' @@ -6624,25 +7290,25 @@ components: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - title: Metadata type: object + title: Metadata + type: object required: - violation_level title: SafetyViolation - type: object + description: Details of a safety violation detected by content moderation. ViolationLevel: - description: Severity level of a safety violation. + type: string enum: - info - warn - error title: ViolationLevel - type: string + description: Severity level of a safety violation. AggregationFunctionType: - description: Types of aggregation functions for scoring results. + type: string enum: - average - weighted_average @@ -6650,193 +7316,176 @@ components: - categorical_count - accuracy title: AggregationFunctionType - type: string + description: Types of aggregation functions for scoring results. ArrayType: - description: Parameter type for array values. properties: type: + type: string const: array - default: array title: Type - type: string - title: ArrayType + default: array type: object + title: ArrayType + description: Parameter type for array values. BasicScoringFnParams: - description: Parameters for basic scoring function configuration. properties: type: - const: basic - default: basic - title: Type type: string + const: basic + title: Type + default: basic aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object title: BasicScoringFnParams - type: object + description: Parameters for basic scoring function configuration. BooleanType: - description: Parameter type for boolean values. properties: type: + type: string const: boolean + title: Type default: boolean - title: Type - type: string + type: object title: BooleanType - type: object + description: Parameter type for boolean values. ChatCompletionInputType: - description: Parameter type for chat completion input. properties: type: + type: string const: chat_completion_input + title: Type default: chat_completion_input - title: Type - type: string + type: object title: ChatCompletionInputType - type: object + description: Parameter type for chat completion input. CompletionInputType: - description: Parameter type for completion input. properties: type: + type: string const: completion_input + title: Type default: completion_input - title: Type - type: string + type: object title: CompletionInputType - type: object + description: Parameter type for completion input. JsonType: - description: Parameter type for JSON values. properties: type: + type: string const: json - default: json title: Type - type: string - title: JsonType + default: json type: object + title: JsonType + description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: - description: Parameters for LLM-as-judge scoring function configuration. properties: type: + type: string const: llm_as_judge - default: llm_as_judge title: Type - type: string + default: llm_as_judge judge_model: - title: Judge Model type: string + title: Judge Model 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 + title: Judge Score Regexes + description: Regexes to extract the answer from generated response aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object required: - judge_model title: LLMAsJudgeScoringFnParams - type: object + description: Parameters for LLM-as-judge scoring function configuration. NumberType: - description: Parameter type for numeric values. properties: type: + type: string const: number + title: Type default: number - title: Type - type: string + type: object title: NumberType - type: object + description: Parameter type for numeric values. ObjectType: - description: Parameter type for object values. properties: type: + type: string const: object - default: object title: Type - type: string - title: ObjectType + default: object type: object + title: ObjectType + description: Parameter type for object values. RegexParserScoringFnParams: - description: Parameters for regex parser scoring function configuration. properties: type: - const: regex_parser - default: regex_parser - title: Type type: string + const: regex_parser + title: Type + default: regex_parser parsing_regexes: - description: Regex to extract the answer from generated response items: type: string - title: Parsing Regexes type: array + title: Parsing Regexes + description: Regex to extract the answer from generated response 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 + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row type: object + title: RegexParserScoringFnParams + description: Parameters for regex parser scoring function configuration. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: scoring_function - default: scoring_function - title: Type type: string + const: scoring_function + title: Type + default: scoring_function description: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - description: Any additional metadata for this definition - title: Metadata type: object + title: Metadata + description: Any additional metadata for this definition 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 @@ -6857,32 +7506,45 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + description: The return type of the deterministic function + discriminator: + propertyName: type + 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' params: anyOf: - - discriminator: - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - propertyName: type - oneOf: + - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + type: object required: - identifier - provider_id - return_type title: ScoringFn - type: object + description: A scoring function resource for evaluating model outputs. ScoringFnParams: discriminator: mapping: @@ -6899,127 +7561,124 @@ components: title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams StringType: - description: Parameter type for string values. properties: type: + type: string const: string - default: string title: Type - type: string - title: StringType + default: string type: object + title: StringType + description: Parameter type for string values. UnionType: - description: Parameter type for union values. properties: type: - const: union - default: union - title: Type type: string - title: UnionType + const: union + title: Type + default: union type: object + title: UnionType + description: Parameter type for union values. ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' - title: Data type: array + title: Data + type: object required: - data title: ListScoringFunctionsResponse - type: object ScoreResponse: - description: The response from scoring. properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Results type: object + title: Results + type: object required: - results title: ScoreResponse - type: object + description: The response from scoring. ScoringResult: - description: A scoring result for a single row. properties: score_rows: items: additionalProperties: true type: object - title: Score Rows type: array + title: Score Rows aggregated_results: additionalProperties: true - title: Aggregated Results type: object + title: Aggregated Results + type: object required: - score_rows - aggregated_results title: ScoringResult - type: object + description: A scoring result for a single row. 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 + title: Results + type: object required: - results title: ScoreBatchResponse - type: object + description: Response from batch scoring operations on datasets. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: shield - default: shield - title: Type type: string + const: shield + title: Type + default: shield params: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true + type: object required: - identifier - provider_id title: Shield - type: object + description: A safety shield resource that can be used to check content. ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' - title: Data type: array + title: Data + type: object required: - data title: ListShieldsResponse - type: object ImageContentItem: description: A image content item properties: @@ -7076,184 +7735,172 @@ components: title: TextContentItem title: ImageContentItem | TextContentItem TextContentItem: - description: A text content item properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: TextContentItem - type: object + description: A text content item 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 + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Output | TextContentItem] - type: 'null' - title: string | list[ImageContentItem | TextContentItem] - nullable: true + title: string | list[ImageContentItem-Output | TextContentItem] 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 + title: ToolInvocationResult + description: Result of a tool invocation. URL: - description: A URL reference to external content. properties: uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URL - type: object + description: A URL reference to external content. ToolDef: - description: Tool definition used in runtime contexts. properties: toolgroup_id: anyOf: - type: string - type: 'null' - nullable: true name: - title: Name type: string + title: Name 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 + type: object required: - name title: ToolDef - type: object + description: Tool definition used in runtime contexts. ListToolDefsResponse: - description: Response containing a list of tool definitions. properties: data: items: $ref: '#/components/schemas/ToolDef' - title: Data type: array + title: Data + type: object required: - data title: ListToolDefsResponse - type: object + description: Response containing a list of tool definitions. ToolGroup: - description: A group of related tools managed together. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: tool_group - default: tool_group - title: Type type: string + const: tool_group + title: Type + default: tool_group 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 + type: object required: - identifier - provider_id title: ToolGroup - type: object + description: A group of related tools managed together. ListToolGroupsResponse: - description: Response containing a list of tool groups. properties: data: items: $ref: '#/components/schemas/ToolGroup' - title: Data type: array + title: Data + type: object required: - data title: ListToolGroupsResponse - type: object + description: Response containing a list of tool groups. Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -7313,105 +7960,94 @@ components: title: Chunk 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 + title: 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. QueryChunksResponse: - description: Response from querying chunks in a vector database. properties: chunks: items: - $ref: '#/components/schemas/Chunk' - title: Chunks + $ref: '#/components/schemas/Chunk-Output' type: array + title: Chunks scores: items: type: number - title: Scores type: array + title: Scores + type: object required: - chunks - scores title: QueryChunksResponse - type: object + description: Response from querying chunks in a vector database. VectorStoreFileCounts: - description: File processing status counts for a vector store. properties: completed: + type: integer title: Completed - type: integer cancelled: + type: integer title: Cancelled - type: integer failed: + type: integer title: Failed - type: integer in_progress: + type: integer title: In Progress - type: integer total: - title: Total type: integer + title: Total + type: object required: - completed - cancelled @@ -7419,91 +8055,85 @@ components: - in_progress - total title: VectorStoreFileCounts - type: object + description: File processing status counts for a vector store. VectorStoreListResponse: - description: Response from listing vector stores. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListResponse - type: object + description: Response from listing vector stores. VectorStoreObject: - description: OpenAI Vector Store object. properties: id: + type: string title: Id - type: string object: - default: vector_store - title: Object type: string + title: Object + default: vector_store created_at: - title: Created At type: integer + title: Created At name: anyOf: - type: string - type: 'null' - nullable: true usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: - default: completed - title: Status type: string + title: Status + default: completed 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 + title: Metadata + type: object required: - id - created_at - file_counts title: VectorStoreObject - type: object + description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: @@ -7517,159 +8147,151 @@ components: title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreChunkingStrategyAuto: - description: Automatic chunking strategy for vector store files. properties: type: + type: string const: auto - default: auto title: Type - type: string - title: VectorStoreChunkingStrategyAuto + default: auto type: object + title: VectorStoreChunkingStrategyAuto + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: - description: Static chunking strategy with configurable parameters. properties: type: - const: static - default: static - title: Type type: string + const: static + title: Type + default: static static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + type: object required: - static title: VectorStoreChunkingStrategyStatic - type: object + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: - description: Configuration for static chunking strategy. properties: chunk_overlap_tokens: - default: 400 + type: integer title: Chunk Overlap Tokens - type: integer + default: 400 max_chunk_size_tokens: - default: 800 - maximum: 4096 - minimum: 100 - title: Max Chunk Size Tokens type: integer - title: VectorStoreChunkingStrategyStaticConfig + maximum: 4096.0 + minimum: 100.0 + title: Max Chunk Size Tokens + default: 800 type: object + title: VectorStoreChunkingStrategyStaticConfig + description: Configuration for static chunking strategy. 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true - title: OpenAICreateVectorStoreRequestWithExtraBody + additionalProperties: true type: object + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. VectorStoreDeleteResponse: - description: Response from deleting a vector store. properties: id: + type: string title: Id - type: string object: - default: vector_store.deleted - title: Object type: string + title: Object + default: vector_store.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreDeleteResponse - type: object + description: Response from deleting a vector store. 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 + title: File Ids 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true + additionalProperties: true + type: object required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - type: object + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: - description: OpenAI Vector Store File Batch object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file_batch + type: string title: Object - type: string + default: vector_store.file_batch created_at: - title: Created At type: integer + title: Created At vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id status: title: Status type: string @@ -7681,6 +8303,7 @@ components: default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' + type: object required: - id - created_at @@ -7688,7 +8311,7 @@ components: - status - file_counts title: VectorStoreFileBatchObject - type: object + description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: type: string enum: @@ -7698,7 +8321,6 @@ components: - failed default: completed VectorStoreFileLastError: - description: Error information for failed vector store file processing. properties: code: title: Code @@ -7708,48 +8330,47 @@ components: - rate_limit_exceeded default: server_error message: - title: Message type: string + title: Message + type: object required: - code - message title: VectorStoreFileLastError - type: object + description: Error information for failed vector store file processing. VectorStoreFileObject: - description: OpenAI Vector Store File object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file - title: Object type: string + title: Object + default: vector_store.file attributes: additionalProperties: true - title: Attributes type: object + title: Attributes 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 + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' created_at: - title: Created At type: integer + title: Created At last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' - nullable: true title: VectorStoreFileLastError status: title: Status @@ -7761,12 +8382,13 @@ components: - failed default: completed usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id + type: object required: - id - chunking_strategy @@ -7774,158 +8396,149 @@ components: - status - vector_store_id title: VectorStoreFileObject - type: object + description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: - description: Response from listing files in a vector store file batch. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreFilesListInBatchResponse - type: object + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: - description: Response from listing files in a vector store. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListFilesResponse - type: object + description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: - description: Response from deleting a vector store file. properties: id: + type: string title: Id - type: string object: - default: vector_store.file.deleted - title: Object type: string + title: Object + default: vector_store.file.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreFileDeleteResponse - type: object + description: Response from deleting a vector store file. VectorStoreContent: - description: Content item from a vector store file or search result. properties: type: + type: string const: text title: Type - type: string text: - title: Text type: string + title: Text 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 + type: object required: - type - text title: VectorStoreContent - type: object + description: Content item from a vector store file or search result. 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 + const: vector_store.file_content.page + title: Object + default: vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data title: VectorStoreFileContentResponse - type: object + description: Represents the parsed content of a vector store file. VectorStoreSearchResponse: - description: Response from searching a vector store. properties: file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename score: - title: Score type: number + title: Score attributes: anyOf: - additionalProperties: @@ -7936,241 +8549,230 @@ components: title: string | number | boolean type: object - type: 'null' - nullable: true content: items: $ref: '#/components/schemas/VectorStoreContent' - title: Content type: array + title: Content + type: object required: - file_id - filename - score - content title: VectorStoreSearchResponse - type: object + description: Response from searching a vector store. VectorStoreSearchResponsePage: - description: Paginated response from searching a vector store. properties: object: - default: vector_store.search_results.page - title: Object type: string + title: Object + default: vector_store.search_results.page search_query: items: type: string - title: Search Query type: array + title: Search Query data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - search_query - data title: VectorStoreSearchResponsePage - type: object + description: Paginated response from searching a vector store. VersionInfo: - description: Version information for the service. properties: version: - title: Version type: string + title: Version + type: object required: - version title: VersionInfo - type: object + description: Version information for the service. PaginatedResponse: - description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More url: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data - has_more title: PaginatedResponse - type: object + description: A generic paginated response that follows a simple format. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: dataset - default: dataset - title: Type type: string + const: dataset + title: Type + default: dataset 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 + discriminator: + propertyName: type + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' metadata: additionalProperties: true - description: Any additional metadata for this dataset - title: Metadata type: object + title: Metadata + description: Any additional metadata for this dataset + type: object required: - identifier - provider_id - purpose - source title: Dataset - type: object + description: Dataset resource for storing and accessing training or evaluation data. RowsDataSource: - description: A dataset stored in rows. properties: type: - const: rows - default: rows - title: Type type: string + const: rows + title: Type + default: rows rows: items: additionalProperties: true type: object - title: Rows type: array + title: Rows + type: object required: - rows title: RowsDataSource - type: object + description: A dataset stored in rows. URIDataSource: - description: A dataset that can be obtained from a URI. properties: type: + type: string const: uri - default: uri title: Type - type: string + default: uri uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URIDataSource - type: object + description: A dataset that can be obtained from a URI. ListDatasetsResponse: - description: Response from listing datasets. properties: data: items: $ref: '#/components/schemas/Dataset' - title: Data type: array + title: Data + type: object required: - data title: ListDatasetsResponse - type: object + description: Response from listing datasets. Benchmark: - description: A benchmark resource for evaluating model performance. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: + type: string const: benchmark - default: benchmark title: Type - type: string + default: benchmark dataset_id: - title: Dataset Id type: string + title: Dataset Id scoring_functions: items: type: string - title: Scoring Functions type: array + title: Scoring Functions metadata: additionalProperties: true - description: Metadata for this evaluation task - title: Metadata type: object + title: Metadata + description: Metadata for this evaluation task + type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark - type: object + description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' - title: Data type: array + title: Data + type: object required: - data title: ListBenchmarksResponse - 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 @@ -8178,41 +8780,46 @@ components: title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + title: Scoring Params + description: Map between scoring function id and parameters for each scoring function you want to run 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 + type: object required: - eval_candidate title: BenchmarkConfig - type: object + description: A benchmark configuration for evaluation. GreedySamplingStrategy: - description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: + type: string const: greedy - default: greedy title: Type - type: string - title: GreedySamplingStrategy + default: greedy type: object + title: GreedySamplingStrategy + description: Greedy sampling strategy that selects the highest probability token at each step. ModelCandidate: - description: A model candidate for evaluation. properties: type: + type: string const: model - default: model title: Type - type: string + default: model model: - title: Model type: string + title: Model sampling_params: $ref: '#/components/schemas/SamplingParams' system_message: @@ -8220,23 +8827,16 @@ components: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' - nullable: true title: SystemMessage + type: object required: - model - sampling_params title: ModelCandidate - type: object + description: A model candidate for evaluation. 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 @@ -8245,11 +8845,16 @@ components: - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + discriminator: + propertyName: type + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' max_tokens: anyOf: - type: integer - type: 'null' - nullable: true repetition_penalty: anyOf: - type: number @@ -8261,74 +8866,73 @@ components: type: string type: array - type: 'null' - nullable: true - title: SamplingParams type: object + title: SamplingParams + description: Sampling parameters. SystemMessage: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string - - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type - oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] - title: string | list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + type: object required: - content title: SystemMessage - type: object + description: A system message providing instructions or context to the model. 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 + const: top_k + title: Type + default: top_k top_k: - minimum: 1 - title: Top K type: integer + minimum: 1.0 + title: Top K + type: object required: - top_k title: TopKSamplingStrategy - type: object + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. 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 + const: top_p + title: Type + default: top_p temperature: anyOf: - type: number @@ -8339,94 +8943,94 @@ components: - type: number - type: 'null' default: 0.95 + type: object required: - temperature title: TopPSamplingStrategy - type: object + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. EvaluateResponse: - description: The response from an evaluation. properties: generations: items: additionalProperties: true type: object - title: Generations type: array + title: Generations scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Scores type: object + title: Scores + type: object required: - generations - scores title: EvaluateResponse - type: object + description: The response from an evaluation. Job: - description: A job execution instance with status tracking. properties: job_id: - title: Job Id type: string + title: Job Id status: $ref: '#/components/schemas/JobStatus' + type: object required: - job_id - status title: Job - type: object + description: A job execution instance with status tracking. RerankData: - description: A single rerank result from a reranking response. properties: index: - title: Index type: integer + title: Index relevance_score: - title: Relevance Score type: number + title: Relevance Score + type: object required: - index - relevance_score title: RerankData - type: object + description: A single rerank result from a reranking response. RerankResponse: - description: Response from a reranking request. properties: data: items: $ref: '#/components/schemas/RerankData' - title: Data type: array + title: Data + type: object required: - data title: RerankResponse - type: object + description: Response from a reranking request. Checkpoint: - description: Checkpoint created during training runs. properties: identifier: - title: Identifier type: string + title: Identifier created_at: + type: string format: date-time title: Created At - type: string epoch: - title: Epoch type: integer + title: Epoch post_training_job_id: + type: string title: Post Training Job Id - type: string path: - title: Path type: string + title: Path training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' - nullable: true title: PostTrainingMetric + type: object required: - identifier - created_at @@ -8434,137 +9038,131 @@ components: - post_training_job_id - path title: Checkpoint - type: object + description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: - description: Artifacts of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid checkpoints: items: $ref: '#/components/schemas/Checkpoint' - title: Checkpoints type: array + title: Checkpoints + type: object required: - job_uuid title: PostTrainingJobArtifactsResponse - type: object + description: Artifacts of a finetuning job. PostTrainingMetric: - description: Training metrics captured during post-training jobs. properties: epoch: - title: Epoch type: integer + title: Epoch train_loss: + type: number title: Train Loss - type: number validation_loss: + type: number title: Validation Loss - type: number perplexity: - title: Perplexity type: number + title: Perplexity + type: object required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric - type: object + description: Training metrics captured during post-training jobs. PostTrainingJobStatusResponse: - description: Status of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true started_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true completed_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - 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 + title: Checkpoints + type: object required: - job_uuid - status title: PostTrainingJobStatusResponse - type: object + description: Status of a finetuning job. ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' - title: Data type: array + title: Data + type: object required: - data title: ListPostTrainingJobsResponse - type: object DPOAlignmentConfig: - description: Configuration for Direct Preference Optimization (DPO) alignment. properties: beta: - title: Beta type: number + title: Beta loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid + type: object required: - beta title: DPOAlignmentConfig - type: object + description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: + type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType - type: string DataConfig: - description: Configuration for training data and data loading. properties: dataset_id: - title: Dataset Id type: string + title: Dataset Id batch_size: - title: Batch Size type: integer + title: Batch Size shuffle: - title: Shuffle type: boolean + title: Shuffle data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' - nullable: true packed: anyOf: - type: boolean @@ -8575,22 +9173,22 @@ components: - type: boolean - type: 'null' default: false + type: object required: - dataset_id - batch_size - shuffle - data_format title: DataConfig - type: object + description: Configuration for training data and data loading. DatasetFormat: - description: Format of the training dataset. + type: string enum: - instruct - dialog title: DatasetFormat - type: string + description: Format of the training dataset. EfficiencyConfig: - description: Configuration for memory and compute efficiency optimizations. properties: enable_activation_checkpointing: anyOf: @@ -8612,51 +9210,51 @@ components: - type: boolean - type: 'null' default: false - title: EfficiencyConfig type: object + title: EfficiencyConfig + description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: - description: Configuration parameters for the optimization algorithm. properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: + type: number title: Lr - type: number weight_decay: - title: Weight Decay type: number + title: Weight Decay num_warmup_steps: - title: Num Warmup Steps type: integer + title: Num Warmup Steps + type: object required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig - type: object + description: Configuration parameters for the optimization algorithm. OptimizerType: - description: Available optimizer algorithms for training. + type: string enum: - adam - adamw - sgd title: OptimizerType - type: string + description: Available optimizer algorithms for training. TrainingConfig: - description: Comprehensive configuration for the training process. properties: n_epochs: + type: integer title: N Epochs - type: integer max_steps_per_epoch: - default: 1 + type: integer title: Max Steps Per Epoch - type: integer - gradient_accumulation_steps: default: 1 - title: Gradient Accumulation Steps + gradient_accumulation_steps: type: integer + title: Gradient Accumulation Steps + default: 1 max_validation_steps: anyOf: - type: integer @@ -8667,40 +9265,38 @@ components: - $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 + type: object required: - n_epochs title: TrainingConfig - type: object + description: Comprehensive configuration for the training process. PostTrainingJob: properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid + type: object required: - job_uuid title: PostTrainingJob - type: object AlgorithmConfig: discriminator: mapping: @@ -8714,30 +9310,29 @@ components: title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig LoraFinetuningConfig: - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. properties: type: - const: LoRA - default: LoRA - title: Type type: string + const: LoRA + title: Type + default: LoRA lora_attn_modules: items: type: string - title: Lora Attn Modules type: array + title: Lora Attn Modules apply_lora_to_mlp: + type: boolean title: Apply Lora To Mlp - type: boolean apply_lora_to_output: - title: Apply Lora To Output type: boolean + title: Apply Lora To Output rank: + type: integer title: Rank - type: integer alpha: - title: Alpha type: integer + title: Alpha use_dora: anyOf: - type: boolean @@ -8748,6 +9343,7 @@ components: - type: boolean - type: 'null' default: false + type: object required: - lora_attn_modules - apply_lora_to_mlp @@ -8755,26 +9351,26 @@ components: - rank - alpha title: LoraFinetuningConfig - type: object + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. properties: type: + type: string const: QAT - default: QAT title: Type - type: string + default: QAT quantizer_name: - title: Quantizer Name type: string + title: Quantizer Name group_size: - title: Group Size type: integer + title: Group Size + type: object required: - quantizer_name - group_size title: QATFinetuningConfig - type: object + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. ParamType: discriminator: mapping: @@ -8820,24 +9416,1329 @@ components: - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource + AllowedToolsFilter: + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can be used. + ApprovalFilter: + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. + BatchError: + properties: + code: + anyOf: + - type: string + - type: 'null' + line: + anyOf: + - type: integer + - type: 'null' + message: + anyOf: + - type: string + - type: 'null' + param: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: BatchError + BatchRequestCounts: + properties: + completed: + type: integer + title: Completed + failed: + type: integer + title: Failed + total: + type: integer + title: Total + additionalProperties: true + type: object + required: + - completed + - failed + - total + title: BatchRequestCounts + BatchUsage: + properties: + input_tokens: + type: integer + title: Input Tokens + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + type: integer + title: Output Tokens + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + type: integer + title: Total Tokens + additionalProperties: true + type: object + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + BatchesPostRequest: + properties: + input_file_id: + type: string + title: Input File Id + endpoint: + type: string + title: Endpoint + completion_window: + type: string + const: 24h + title: Completion Window + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + idempotency_key: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_file_id + - endpoint + - completion_window + title: BatchesPostRequest + Body_openai_upload_file_v1_files_post: + properties: + file: + type: string + format: binary + title: File + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + expires_after: + anyOf: + - $ref: '#/components/schemas/ExpiresAfter' + title: ExpiresAfter + - type: 'null' + title: ExpiresAfter + type: object + required: + - file + - purpose + title: Body_openai_upload_file_v1_files_post + Chunk-Input: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + Chunk-Output: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + type: array + title: list[ImageContentItem-Output | TextContentItem] + title: string | list[ImageContentItem-Output | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + ConversationItemInclude: + type: string + enum: + - web_search_call.action.sources + - code_interpreter_call.outputs + - computer_call_output.output.image_url + - file_search_call.results + - message.input_image.image_url + - message.output_text.logprobs + - reasoning.encrypted_content + title: ConversationItemInclude + description: Specify additional output data to include in the model response. + ConversationsByConversationIdItemsPostRequest: + properties: + items: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + title: Items + type: object + required: + - items + title: ConversationsByConversationIdItemsPostRequest + ConversationsByConversationIdPostRequest: + properties: + metadata: + additionalProperties: + type: string + type: object + title: Metadata + type: object + required: + - metadata + title: ConversationsByConversationIdPostRequest + ConversationsPostRequest: + properties: + items: + anyOf: + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + - type: 'null' + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + type: object + title: ConversationsPostRequest + DatasetPurpose: + type: string + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + description: Purpose of the dataset. Each purpose has a required input data schema. + Errors: + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + object: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: Errors + HealthStatus: + type: string + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + ImageContentItem-Input: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + ImageContentItem-Output: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + InputTokensDetails: + properties: + cached_tokens: + type: integer + title: Cached Tokens + additionalProperties: true + type: object + required: + - cached_tokens + title: InputTokensDetails + JobStatus: + type: string + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + description: Status of a job execution. + MCPListToolsTool: + properties: + input_schema: + additionalProperties: true + type: object + title: Input Schema + name: + type: string + title: Name + description: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_schema + - name + title: MCPListToolsTool + description: Tool definition returned by MCP list tools operation. + ModerationsPostRequest: + properties: + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + model: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input + title: ModerationsPostRequest + OpenAIAssistantMessageParam-Input: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIAssistantMessageParam-Output: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIChatCompletionUsageCompletionTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. + OpenAIChatCompletionUsagePromptTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. + OpenAIResponseMessage-Input: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseMessage-Output: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseOutputMessageFileSearchToolCallResults: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + file_id: + type: string + title: File Id + filename: + type: string + title: Filename + score: + type: number + title: Score + text: + type: string + title: Text + type: object + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + OpenAIResponseTextFormat: + 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' + type: object + title: OpenAIResponseTextFormat + description: Configuration for Responses API text format. + OpenAIResponseUsageInputTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageInputTokensDetails + description: Token details for input tokens in OpenAI response usage. + OpenAIResponseUsageOutputTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageOutputTokensDetails + description: Token details for output tokens in OpenAI response usage. + OpenAIUserMessageParam-Input: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OpenAIUserMessageParam-Output: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OutputTokensDetails: + properties: + reasoning_tokens: + type: integer + title: Reasoning Tokens + additionalProperties: true + type: object + required: + - reasoning_tokens + title: OutputTokensDetails + PromptsByPromptIdPostRequest: + properties: + prompt: + type: string + title: Prompt + version: + type: integer + title: Version + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + set_as_default: + type: boolean + title: Set As Default + default: true + type: object + required: + - prompt + - version + title: PromptsByPromptIdPostRequest + PromptsByPromptIdSetDefaultVersionPostRequest: + properties: + version: + type: integer + title: Version + type: object + required: + - version + title: PromptsByPromptIdSetDefaultVersionPostRequest + PromptsPostRequest: + properties: + prompt: + type: string + title: Prompt + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + required: + - prompt + title: PromptsPostRequest + ResponsesPostRequest: + properties: + input: + anyOf: + - type: string + - items: + anyOf: + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input + type: array + title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + model: + type: string + title: Model + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + title: OpenAIResponsePrompt + instructions: + anyOf: + - type: string + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + conversation: + anyOf: + - type: string + - type: 'null' + store: + anyOf: + - type: boolean + - type: 'null' + default: true + stream: + anyOf: + - type: boolean + - type: 'null' + default: false + temperature: + anyOf: + - type: number + - type: 'null' + text: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseText' + title: OpenAIResponseText + - type: 'null' + title: OpenAIResponseText + tools: + anyOf: + - items: + 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 + discriminator: + propertyName: type + 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' + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + include: + anyOf: + - items: + type: string + type: array + - type: 'null' + max_infer_iters: + anyOf: + - type: integer + - type: 'null' + default: 10 + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - input + - model + title: ResponsesPostRequest + SafetyRunShieldPostRequest: + properties: + shield_id: + type: string + title: Shield Id + messages: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array + title: Messages + params: + additionalProperties: true + type: object + title: Params + type: object + required: + - shield_id + - messages + - params + title: SafetyRunShieldPostRequest + ScoringScoreBatchPostRequest: + properties: + dataset_id: + type: string + title: Dataset Id + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + save_results_dataset: + type: boolean + title: Save Results Dataset + default: false + type: object + required: + - dataset_id + - scoring_functions + title: ScoringScoreBatchPostRequest + ScoringScorePostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + type: object + required: + - input_rows + - scoring_functions + title: ScoringScorePostRequest + SearchRankingOptions: + properties: + ranker: + anyOf: + - type: string + - type: 'null' + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + type: object + title: SearchRankingOptions + description: Options for ranking and filtering search results. + ToolRuntimeInvokePostRequest: + properties: + tool_name: + type: string + title: Tool Name + kwargs: + additionalProperties: true + type: object + title: Kwargs + authorization: + anyOf: + - type: string + - type: 'null' + type: object + required: + - tool_name + - kwargs + title: ToolRuntimeInvokePostRequest + VectorIoQueryPostRequest: + properties: + vector_store_id: + type: string + title: Vector Store Id + query: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - vector_store_id + - query + title: VectorIoQueryPostRequest + VectorStoresByVectorStoreIdFilesByFileIdPostRequest: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + type: object + required: + - attributes + title: VectorStoresByVectorStoreIdFilesByFileIdPostRequest + VectorStoresByVectorStoreIdFilesPostRequest: + properties: + file_id: + type: string + title: File Id + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + chunking_strategy: + anyOf: + - oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + type: object + required: + - file_id + title: VectorStoresByVectorStoreIdFilesPostRequest + VectorStoresByVectorStoreIdPostRequest: + properties: + name: + anyOf: + - type: string + - type: 'null' + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: VectorStoresByVectorStoreIdPostRequest + VectorStoresByVectorStoreIdSearchPostRequest: + 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' + max_num_results: + anyOf: + - type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + title: SearchRankingOptions + rewrite_query: + anyOf: + - type: boolean + - type: 'null' + default: false + search_mode: + anyOf: + - type: string + - type: 'null' + default: vector + type: object + required: + - query + title: VectorStoresByVectorStoreIdSearchPostRequest _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 + title: _URLOrData + description: A URL or a base64 encoded string SamplingStrategy: discriminator: mapping: @@ -8897,99 +10798,6 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat - 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 - 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 - 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 - 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 OpenAIResponseContentPart: discriminator: mapping: @@ -9005,56 +10813,6 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText - 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 - 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 SpanEndPayload: description: Payload for a span end event. properties: @@ -9276,110 +11034,6 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - 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 ImageDelta: description: An image content delta for streaming responses. properties: @@ -9411,16 +11065,6 @@ components: - text title: TextDelta type: object - JobStatus: - description: Status of a job execution. - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - type: string MetricInResponse: description: A metric value included in API responses. properties: @@ -9536,14 +11180,6 @@ components: - 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 Api: description: Enumeration of all available APIs in the Llama Stack system. enum: @@ -9616,7 +11252,6 @@ components: - `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 @@ -9707,7 +11342,6 @@ components: - `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 @@ -9781,7 +11415,6 @@ components: - `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 @@ -9872,26 +11505,6 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig 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 OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -10062,13 +11675,6 @@ components: - content title: UserMessage type: object - HealthStatus: - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - type: string PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -10249,3 +11855,131 @@ components: - query title: VectorStoreSearchRequest type: object + 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' +tags: +- description: APIs for creating and interacting with agentic systems. + name: Agents + x-displayName: Agents +- description: |- + The API is designed to allow use of openai client libraries for seamless integration. + + This API provides the following extensions: + - idempotent batch creation + + Note: This API is currently under active development and may undergo changes. + name: Batches + x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale. +- description: '' + name: Benchmarks +- description: Protocol for conversation management operations. + name: Conversations + x-displayName: Conversations +- description: '' + name: DatasetIO +- description: '' + name: Datasets +- description: Llama Stack Evaluation API for running evaluations on model and agent candidates. + name: Eval + x-displayName: Evaluations +- description: This API is used to upload documents that can be used with other Llama Stack APIs. + name: Files + x-displayName: Files +- description: |- + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Three kinds of models are supported: + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. + - Rerank models: these models reorder the documents based on their relevance to a query. + name: Inference + x-displayName: Inference +- description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers. + name: Inspect + x-displayName: Inspect +- description: '' + name: Models +- description: '' + name: PostTraining (Coming Soon) +- description: Protocol for prompt management operations. + name: Prompts + x-displayName: Prompts +- description: Providers API for inspecting, listing, and modifying providers and their configurations. + name: Providers + x-displayName: Providers +- description: OpenAI-compatible Moderations API. + name: Safety + x-displayName: Safety +- description: '' + name: Scoring +- description: '' + name: ScoringFunctions +- description: '' + name: Shields +- description: '' + name: ToolGroups +- description: '' + name: ToolRuntime +- description: '' + name: VectorIO +x-tagGroups: +- name: Operations + tags: + - Agents + - Batches + - Benchmarks + - Conversations + - DatasetIO + - Datasets + - Eval + - Files + - Inference + - Inspect + - Models + - PostTraining (Coming Soon) + - Prompts + - Providers + - Safety + - Scoring + - ScoringFunctions + - Shields + - ToolGroups + - ToolRuntime + - VectorIO +security: +- Default: [] diff --git a/docs/static/stainless-llama-stack-spec.yaml b/docs/static/stainless-llama-stack-spec.yaml index d5324828a..1a55e80b6 100644 --- a/docs/static/stainless-llama-stack-spec.yaml +++ b/docs/static/stainless-llama-stack-spec.yaml @@ -16,39 +16,86 @@ servers: paths: /v1/batches: get: + responses: + '200': + description: A list of batch objects. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBatchesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Batches summary: List Batches + description: List all batches for the current user. operationId: list_batches_v1_batches_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + type: integer + default: 20 + title: Limit + post: responses: '200': - description: Successful Response + description: The created batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Batches summary: Create Batch + description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BatchesPostRequest' + /v1/batches/{batch_id}: + get: responses: '200': - description: Successful Response + description: The batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -61,30 +108,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/batches/{batch_id}: - get: tags: - Batches summary: Retrieve Batch + description: Retrieve information about a specific 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 @@ -94,16 +122,13 @@ paths: description: 'Path parameter: batch_id' /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 + description: The updated batch object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Batch' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -116,6 +141,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Batches + summary: Cancel Batch + description: Cancel a batch that is in progress. + operationId: cancel_batch_v1_batches__batch_id__cancel_post parameters: - name: batch_id in: path @@ -125,39 +155,111 @@ paths: description: 'Path parameter: batch_id' /v1/chat/completions: get: + responses: + '200': + description: A ListOpenAIChatCompletionResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Inference summary: List Chat Completions + description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: model + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Model + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: An OpenAIChatCompletion. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIChatCompletion' + text/event-stream: + schema: + $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Inference summary: Openai Chat Completion + description: |- + Create chat completions. + + Generate an OpenAI-compatible chat completion for the given messages using the specified model. operationId: openai_chat_completion_v1_chat_completions_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' + /v1/chat/completions/{completion_id}: + get: responses: '200': - description: Successful Response + description: A OpenAICompletionWithInputMessages. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -170,30 +272,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/chat/completions/{completion_id}: - get: tags: - Inference summary: Get Chat Completion + description: |- + Get chat completion. + + Describe a chat completion by its ID. 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 @@ -203,16 +289,48 @@ paths: description: 'Path parameter: completion_id' /v1/completions: post: + responses: + '200': + description: An OpenAICompletion. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICompletion' + '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' tags: - Inference summary: Openai Completion + description: |- + Create completion. + + Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' + required: true + /v1/conversations: + post: responses: '200': - description: Successful Response + description: The created conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -225,18 +343,29 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/conversations: - post: tags: - Conversations summary: Create Conversation + description: |- + Create a conversation. + + Create a conversation. operationId: create_conversation_v1_conversations_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsPostRequest' + required: true + /v1/conversations/{conversation_id}: + get: responses: '200': - description: Successful Response + description: The conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -249,30 +378,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/conversations/{conversation_id}: - get: tags: - Conversations summary: Get Conversation + description: |- + Retrieve a conversation. + + Get a conversation with the given ID. 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 @@ -281,16 +394,13 @@ paths: 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 + description: The updated conversation object. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -303,6 +413,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Update Conversation + description: |- + Update a conversation. + + Update a conversation's metadata with the given ID. + operationId: update_conversation_v1_conversations__conversation_id__post parameters: - name: conversation_id in: path @@ -310,17 +428,20 @@ paths: schema: type: string description: 'Path parameter: conversation_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsByConversationIdPostRequest' + required: true delete: - tags: - - Conversations - summary: Openai Delete Conversation - operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': - description: Successful Response + description: The deleted conversation resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ConversationDeletedResource' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -333,6 +454,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Openai Delete Conversation + description: |- + Delete a conversation. + + Delete a conversation with the given ID. + operationId: openai_delete_conversation_v1_conversations__conversation_id__delete parameters: - name: conversation_id in: path @@ -342,58 +471,105 @@ paths: description: 'Path parameter: conversation_id' /v1/conversations/{conversation_id}/items: get: + responses: + '200': + description: List of conversation items. + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationItemList' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Conversations summary: List Items + description: |- + List items. + + List items in the conversation. 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - enum: + - asc + - desc + type: string + - type: 'null' + title: Order - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' + - name: include + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/ConversationItemInclude' + - type: 'null' + title: Include post: + responses: + '200': + description: List of created items. + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationItemList' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Conversations summary: Add Items + description: |- + Create items. + + Create items in the conversation. 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 @@ -401,18 +577,21 @@ paths: schema: type: string description: 'Path parameter: conversation_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConversationsByConversationIdItemsPostRequest' /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 + description: The conversation item. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseMessage' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -425,6 +604,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Retrieve + description: |- + Retrieve an item. + + Retrieve a conversation item. + operationId: retrieve_v1_conversations__conversation_id__items__item_id__get parameters: - name: conversation_id in: path @@ -439,16 +626,13 @@ paths: 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 + description: The deleted item resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ConversationItemDeletedResource' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -461,6 +645,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Conversations + summary: Openai Delete Conversation Item + description: |- + Delete an item. + + Delete a conversation item. + operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete parameters: - name: conversation_id in: path @@ -476,63 +668,151 @@ paths: description: 'Path parameter: item_id' /v1/embeddings: post: + responses: + '200': + description: An OpenAIEmbeddingsResponse containing the embeddings. + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIEmbeddingsResponse' + '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' tags: - Inference summary: Openai Embeddings + description: |- + Create embeddings. + + Generate OpenAI-compatible embeddings for the given input using the specified model. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' + required: true /v1/files: get: + responses: + '200': + description: An ListOpenAIFileResponse containing the list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIFileResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Files summary: Openai List Files + description: |- + List files. + + Returns a list of files that belong to the user's organization. operationId: openai_list_files_v1_files_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 10000 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + - name: purpose + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/OpenAIFilePurpose' + - type: 'null' + title: Purpose + post: responses: '200': - description: Successful Response + description: An OpenAIFileObject representing the uploaded file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileObject' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Files summary: Openai Upload File + description: |- + Upload file. + + Upload a file that can be used across various endpoints. + + The file upload should be a multipart form request with: + - file: The File object (not file name) to be uploaded. + - purpose: The intended purpose of the uploaded file. + - expires_after: Optional form values describing expiration for the file. operationId: openai_upload_file_v1_files_post + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Body_openai_upload_file_v1_files_post' + /v1/files/{file_id}: + get: responses: '200': - description: Successful Response + description: An OpenAIFileObject containing file information. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -545,30 +825,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/files/{file_id}: - get: tags: - Files summary: Openai Retrieve File + description: |- + Retrieve file. + + Returns information about a specific 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 @@ -577,16 +841,13 @@ paths: 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 + description: An OpenAIFileDeleteResponse indicating successful deletion. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIFileDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -599,6 +860,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Files + summary: Openai Delete File + description: Delete file. + operationId: openai_delete_file_v1_files__file_id__delete parameters: - name: file_id in: path @@ -608,16 +874,13 @@ paths: description: 'Path parameter: file_id' /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 + description: The raw file content as a binary response. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Response' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -630,6 +893,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Files + summary: Openai Retrieve File Content + description: |- + Retrieve file content. + + Returns the contents of the specified file. + operationId: openai_retrieve_file_content_v1_files__file_id__content_get parameters: - name: file_id in: path @@ -639,40 +910,85 @@ paths: description: 'Path parameter: file_id' /v1/health: get: + responses: + '200': + description: Health information indicating if the service is operational. + content: + application/json: + schema: + $ref: '#/components/schemas/HealthInfo' + '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' tags: - Inspect summary: Health + description: |- + Get health status. + + Get the current health status of the service. 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: + responses: + '200': + description: Response containing information about all available routes. + content: + application/json: + schema: + $ref: '#/components/schemas/ListRoutesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Inspect summary: List Routes + description: |- + List routes. + + List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get + parameters: + - name: api_filter + in: query + required: false + schema: + anyOf: + - enum: + - v1 + - v1alpha + - v1beta + - deprecated + type: string + - type: 'null' + title: Api Filter + /v1/models: + get: responses: '200': - description: Successful Response + description: A OpenAIListModelsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIListModelsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -685,18 +1001,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/models: - get: tags: - Models summary: Openai List Models + description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get + post: responses: '200': - description: Successful Response + description: A Model. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Model' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -709,36 +1026,58 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Models summary: Register Model + description: |- + Register model. + + Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModelsPostRequest' + required: true deprecated: true /v1/models/{model_id}: get: + responses: + '200': + description: A Model. + content: + application/json: + schema: + $ref: '#/components/schemas/Model' + '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' tags: - Models summary: Get Model + description: |- + Get model. + + Get a model by its identifier. operationId: get_model_v1_models__model_id__get + parameters: + - name: model_id + in: path + required: true + schema: + type: string + description: 'Path parameter: model_id' + delete: responses: '200': description: Successful Response @@ -757,37 +1096,14 @@ paths: 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 + description: |- + Unregister model. + + Unregister a 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 @@ -795,18 +1111,51 @@ paths: schema: type: string description: 'Path parameter: model_id' + deprecated: true /v1/moderations: post: + responses: + '200': + description: A moderation object. + content: + application/json: + schema: + $ref: '#/components/schemas/ModerationObject' + '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' tags: - Safety summary: Run Moderation + description: |- + Create moderation. + + Classifies if text and/or image inputs are potentially harmful. operationId: run_moderation_v1_moderations_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModerationsPostRequest' + required: true + /v1/prompts: + get: responses: '200': - description: Successful Response + description: A ListPromptsResponse containing all prompts. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -819,18 +1168,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/prompts: - get: tags: - Prompts summary: List Prompts + description: List all prompts. operationId: list_prompts_v1_prompts_get + post: responses: '200': - description: Successful Response + description: The created Prompt resource. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -843,54 +1193,58 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Prompts summary: Create Prompt + description: |- + Create prompt. + + Create a new 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsPostRequest' + required: true /v1/prompts/{prompt_id}: get: + responses: + '200': + description: A Prompt resource. + content: + application/json: + schema: + $ref: '#/components/schemas/Prompt' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Prompts summary: Get Prompt + description: |- + Get prompt. + + Get a prompt by its identifier and optional version. 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: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version - name: prompt_id in: path required: true @@ -898,28 +1252,33 @@ paths: type: string description: 'Path parameter: prompt_id' post: + responses: + '200': + description: The updated Prompt resource with incremented version. + content: + application/json: + schema: + $ref: '#/components/schemas/Prompt' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Prompts summary: Update Prompt + description: |- + Update prompt. + + Update an existing prompt (increments version). 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 @@ -927,11 +1286,13 @@ paths: schema: type: string description: 'Path parameter: prompt_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsByPromptIdPostRequest' delete: - tags: - - Prompts - summary: Delete Prompt - operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': description: Successful Response @@ -939,17 +1300,25 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' + description: Default Response + tags: + - Prompts + summary: Delete Prompt + description: |- + Delete prompt. + + Delete a prompt. + operationId: delete_prompt_v1_prompts__prompt_id__delete parameters: - name: prompt_id in: path @@ -959,16 +1328,13 @@ paths: 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 + description: The prompt with the specified version now set as default. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -981,6 +1347,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Prompts + summary: Set Default Version + description: |- + Set prompt version. + + Set which version of a prompt should be the default in get_prompt (latest). + operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post parameters: - name: prompt_id in: path @@ -988,18 +1362,21 @@ paths: schema: type: string description: 'Path parameter: prompt_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromptsByPromptIdSetDefaultVersionPostRequest' + required: true /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 + description: A ListPromptsResponse containing all versions of the prompt. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1012,6 +1389,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Prompts + summary: List Prompt Versions + description: |- + List prompt versions. + + List all versions of a specific prompt. + operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get parameters: - name: prompt_id in: path @@ -1021,16 +1406,42 @@ paths: description: 'Path parameter: prompt_id' /v1/providers: get: + responses: + '200': + description: A ListProvidersResponse containing information about all providers. + content: + application/json: + schema: + $ref: '#/components/schemas/ListProvidersResponse' + '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' tags: - Providers summary: List Providers + description: |- + List providers. + + List all available providers. operationId: list_providers_v1_providers_get + /v1/providers/{provider_id}: + get: responses: '200': - description: Successful Response + description: A ProviderInfo object containing the provider's details. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ProviderInfo' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1043,30 +1454,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/providers/{provider_id}: - get: tags: - Providers summary: Inspect Provider + description: |- + Get provider. + + Get detailed information about a specific 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 @@ -1076,39 +1471,132 @@ paths: description: 'Path parameter: provider_id' /v1/responses: get: + responses: + '200': + description: A ListOpenAIResponseObject. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIResponseObject' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Agents summary: List Openai Responses + description: List all responses. operationId: list_openai_responses_v1_responses_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 50 + title: Limit + - name: model + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Model + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: An OpenAIResponseObject. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseObject' + text/event-stream: + schema: + $ref: '#/components/schemas/OpenAIResponseObjectStream' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Agents summary: Create Openai Response + description: Create a model response. operationId: create_openai_response_v1_responses_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ResponsesPostRequest' + x-llama-stack-extra-body-params: + guardrails: + $defs: + ResponseGuardrailSpec: + description: |- + Specification for a guardrail to apply during response generation. + + :param type: The type/identifier of the guardrail. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + anyOf: + - items: + anyOf: + - type: string + - $ref: '#/components/schemas/ResponseGuardrailSpec' + type: array + - type: 'null' + description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation. + /v1/responses/{response_id}: + get: responses: '200': - description: Successful Response + description: An OpenAIResponseObject. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIResponseObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1121,30 +1609,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/responses/{response_id}: - get: tags: - Agents summary: Get Openai Response + description: Get a model 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 @@ -1153,16 +1622,13 @@ paths: 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 + description: An OpenAIDeleteResponseObject content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/OpenAIDeleteResponseObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1175,6 +1641,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Agents + summary: Delete Openai Response + description: Delete a response. + operationId: delete_openai_response_v1_responses__response_id__delete parameters: - name: response_id in: path @@ -1184,65 +1655,143 @@ paths: description: 'Path parameter: response_id' /v1/responses/{response_id}/input_items: get: + responses: + '200': + description: An ListOpenAIResponseInputItem. + content: + application/json: + schema: + $ref: '#/components/schemas/ListOpenAIResponseInputItem' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Agents summary: List Openai Response Input Items + description: List 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/Order' + - type: 'null' + default: desc + title: Order - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' + - name: include + in: query + required: false + schema: + anyOf: + - type: array + items: + type: string + - type: 'null' + title: Include /v1/safety/run-shield: post: + responses: + '200': + description: A RunShieldResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/RunShieldResponse' + '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' tags: - Safety summary: Run Shield + description: |- + Run shield. + + Run a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SafetyRunShieldPostRequest' + required: true /v1/scoring-functions: get: + responses: + '200': + description: A ListScoringFunctionsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListScoringFunctionsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Scoring Functions summary: List Scoring Functions + description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get + post: responses: '200': description: Successful Response @@ -1250,47 +1799,63 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Scoring Functions summary: Register Scoring Function + description: Register a 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_scoring_function_v1_scoring_functions_post' deprecated: true /v1/scoring-functions/{scoring_fn_id}: get: + responses: + '200': + description: A ScoringFn. + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringFn' + '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' tags: - Scoring Functions summary: Get Scoring Function + description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get + parameters: + - name: scoring_fn_id + in: path + required: true + schema: + type: string + description: 'Path parameter: scoring_fn_id' + delete: responses: '200': description: Successful Response @@ -1309,37 +1874,11 @@ paths: 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 + description: Unregister a 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 @@ -1347,18 +1886,48 @@ paths: schema: type: string description: 'Path parameter: scoring_fn_id' + deprecated: true /v1/scoring/score: post: + responses: + '200': + description: A ScoreResponse object containing rows and aggregated results. + content: + application/json: + schema: + $ref: '#/components/schemas/ScoreResponse' + '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' tags: - Scoring summary: Score + description: Score a list of rows. operationId: score_v1_scoring_score_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringScorePostRequest' + required: true + /v1/scoring/score-batch: + post: responses: '200': - description: Successful Response + description: A ScoreBatchResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ScoreBatchResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1371,18 +1940,26 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/scoring/score-batch: - post: tags: - Scoring summary: Score Batch + description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScoringScoreBatchPostRequest' + required: true + /v1/shields: + get: responses: '200': - description: Successful Response + description: A ListShieldsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListShieldsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1395,18 +1972,19 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/shields: - get: tags: - Shields summary: List Shields + description: List all shields. operationId: list_shields_v1_shields_get + post: responses: '200': - description: Successful Response + description: A Shield. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Shield' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1419,36 +1997,52 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Shields summary: Register Shield + description: Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldsPostRequest' + required: true deprecated: true /v1/shields/{identifier}: get: + responses: + '200': + description: A Shield. + content: + application/json: + schema: + $ref: '#/components/schemas/Shield' + '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' tags: - Shields summary: Get Shield + description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get + parameters: + - name: identifier + in: path + required: true + schema: + type: string + description: 'Path parameter: identifier' + delete: responses: '200': description: Successful Response @@ -1467,37 +2061,11 @@ paths: 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 + description: Unregister a 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 @@ -1505,60 +2073,117 @@ paths: schema: type: string description: 'Path parameter: identifier' + deprecated: true /v1/tool-runtime/invoke: post: + responses: + '200': + description: A ToolInvocationResult. + content: + application/json: + schema: + $ref: '#/components/schemas/ToolInvocationResult' + '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' tags: - Tool Runtime summary: Invoke Tool + description: Run a tool with the given arguments. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ToolRuntimeInvokePostRequest' + required: true /v1/tool-runtime/list-tools: get: + responses: + '200': + description: A ListToolDefsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolDefsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Runtime summary: List Runtime Tools + description: List all tools in the runtime. 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' + parameters: + - name: authorization + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + - name: tool_group_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Tool Group Id + - name: mcp_endpoint + in: query + required: false + schema: + anyOf: + - $ref: '#/components/schemas/URL' + - type: 'null' + title: Mcp Endpoint /v1/toolgroups: get: + responses: + '200': + description: A ListToolGroupsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolGroupsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tool Groups + description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get + post: responses: '200': description: Successful Response @@ -1566,53 +2191,37 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Tool Groups summary: Register Tool Group + description: Register a 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_tool_group_v1_toolgroups_post' deprecated: true /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 + description: A ToolGroup. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ToolGroup' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1625,6 +2234,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Tool Groups + summary: Get Tool Group + description: Get a tool group by its ID. + operationId: get_tool_group_v1_toolgroups__toolgroup_id__get parameters: - name: toolgroup_id in: path @@ -1633,10 +2247,6 @@ paths: 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 @@ -1655,7 +2265,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - deprecated: true + tags: + - Tool Groups + summary: Unregister Toolgroup + description: Unregister a tool group. + operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete parameters: - name: toolgroup_id in: path @@ -1663,18 +2277,51 @@ paths: schema: type: string description: 'Path parameter: toolgroup_id' + deprecated: true /v1/tools: get: + responses: + '200': + description: A ListToolDefsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolDefsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Tool Groups summary: List Tools + description: List tools with optional tool group. operationId: list_tools_v1_tools_get + parameters: + - name: toolgroup_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Toolgroup Id + /v1/tools/{tool_name}: + get: responses: '200': - description: Successful Response + description: A ToolDef. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ToolDef' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1687,30 +2334,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/tools/{tool_name}: - get: tags: - Tool Groups summary: Get Tool + description: Get a tool by its name. 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 @@ -1720,16 +2348,47 @@ paths: description: 'Path parameter: tool_name' /v1/vector-io/insert: post: + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Insert Chunks + description: Insert chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Chunk-Input' + title: Chunks + /v1/vector-io/query: + post: responses: '200': - description: Successful Response + description: A QueryChunksResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/QueryChunksResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1742,65 +2401,121 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/vector-io/query: - post: tags: - Vector Io summary: Query Chunks + description: Query chunks from a vector database. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorIoQueryPostRequest' + required: true /v1/vector_stores: get: + responses: + '200': + description: A VectorStoreListResponse containing the list of vector stores. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreListResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Vector Stores + description: Returns a list of vector stores. operationId: openai_list_vector_stores_v1_vector_stores_get + parameters: + - name: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order + post: responses: '200': - description: Successful Response + description: A VectorStoreObject representing the created vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Vector Io summary: Openai Create Vector Store + description: |- + Creates a vector store. + + Generate an OpenAI-compatible vector store with the given parameters. operationId: openai_create_vector_store_v1_vector_stores_post + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' + /v1/vector_stores/{vector_store_id}: + get: responses: '200': - description: Successful Response + description: A VectorStoreObject representing the vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1813,30 +2528,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1/vector_stores/{vector_store_id}: - get: tags: - Vector Io summary: Openai Retrieve Vector Store + description: Retrieves a 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 @@ -1845,16 +2541,13 @@ paths: 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 + description: A VectorStoreObject representing the updated vector store. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1867,6 +2560,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Update Vector Store + description: Updates a vector store. + operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post parameters: - name: vector_store_id in: path @@ -1874,17 +2572,20 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdPostRequest' + required: true 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 + description: A VectorStoreDeleteResponse indicating the deletion status. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1897,6 +2598,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Delete Vector Store + description: Delete a vector store. + operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete parameters: - name: vector_store_id in: path @@ -1906,16 +2612,13 @@ paths: description: 'Path parameter: vector_store_id' /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 + description: A VectorStoreFileBatchObject representing the created file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1928,6 +2631,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Create Vector Store File Batch + description: |- + Create a vector store file batch. + + Generate an OpenAI-compatible vector store file batch for the given vector store. + operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post parameters: - name: vector_store_id in: path @@ -1935,18 +2646,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' + required: true /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 + description: A VectorStoreFileBatchObject representing the file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1959,6 +2673,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Retrieve Vector Store File Batch + description: Retrieve a vector store file batch. + operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get parameters: - name: vector_store_id in: path @@ -1974,16 +2693,13 @@ paths: description: 'Path parameter: batch_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 + description: A VectorStoreFileBatchObject representing the cancelled file batch. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1996,6 +2712,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Cancel Vector Store File Batch + description: Cancels a vector store file batch. + operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post parameters: - name: vector_store_id in: path @@ -2011,29 +2732,73 @@ paths: description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files: get: + responses: + '200': + description: A VectorStoreFilesListInBatchResponse containing the list of files in the batch. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Files In Vector Store File Batch + description: Returns a list of vector store files in a 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: filter + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Filter + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order - name: vector_store_id in: path required: true @@ -2048,29 +2813,78 @@ paths: description: 'Path parameter: batch_id' /v1/vector_stores/{vector_store_id}/files: get: + responses: + '200': + description: A VectorStoreListFilesResponse containing the list of files. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreListFilesResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai List Files In Vector Store + description: List files in a 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: after + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: After + - name: before + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Before + - name: filter + in: query + required: false + schema: + title: Filter + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + nullable: true + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + default: 20 + title: Limit + - name: order + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + default: desc + title: Order - name: vector_store_id in: path required: true @@ -2078,28 +2892,30 @@ paths: type: string description: 'Path parameter: vector_store_id' post: + responses: + '200': + description: A VectorStoreFileObject representing the attached file. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileObject' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai Attach File To Vector Store + description: Attach a file to a 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 @@ -2107,18 +2923,21 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdFilesPostRequest' /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 + description: A VectorStoreFileObject representing the file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2131,6 +2950,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Retrieve Vector Store File + description: Retrieves a vector store file. + operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get parameters: - name: vector_store_id in: path @@ -2145,16 +2969,13 @@ paths: 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 + description: A VectorStoreFileObject representing the updated file. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2167,6 +2988,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Update Vector Store File + description: Updates a vector store file. + operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post parameters: - name: vector_store_id in: path @@ -2180,17 +3006,20 @@ paths: schema: type: string description: 'Path parameter: file_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdFilesByFileIdPostRequest' + required: true 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 + description: A VectorStoreFileDeleteResponse indicating the deletion status. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreFileDeleteResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2203,6 +3032,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Delete Vector Store File + description: Delete a vector store file. + operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete parameters: - name: vector_store_id in: path @@ -2218,29 +3052,49 @@ paths: description: 'Path parameter: file_id' /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: + responses: + '200': + description: File contents, optionally with embeddings and metadata based on query parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoreFileContentResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Vector Io summary: Openai Retrieve Vector Store File Contents + description: Retrieves the contents of a vector store file. 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: include_embeddings + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + default: false + title: Include Embeddings + - name: include_metadata + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + default: false + title: Include Metadata - name: vector_store_id in: path required: true @@ -2255,16 +3109,13 @@ paths: 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 + description: A VectorStoreSearchResponse containing the search results. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/VectorStoreSearchResponsePage' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2277,6 +3128,14 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Vector Io + summary: Openai Search Vector Store + description: |- + Search for chunks in a vector store. + + Searches a vector store for relevant chunks based on a query and optional file attribute filters. + operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post parameters: - name: vector_store_id in: path @@ -2284,12 +3143,43 @@ paths: schema: type: string description: 'Path parameter: vector_store_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VectorStoresByVectorStoreIdSearchPostRequest' + required: true /v1/version: get: + responses: + '200': + description: Version information containing the service version number. + content: + application/json: + schema: + $ref: '#/components/schemas/VersionInfo' + '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' tags: - Inspect summary: Version + description: |- + Get version. + + Get the version of the service. operationId: version_v1_version_get + /v1beta/datasetio/append-rows/{dataset_id}: + post: responses: '200': description: Successful Response @@ -2308,30 +3198,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1beta/datasetio/append-rows/{dataset_id}: - post: tags: - Datasetio summary: Append Rows + description: Append rows to a dataset. 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 @@ -2339,31 +3210,68 @@ paths: schema: type: string description: 'Path parameter: dataset_id' + requestBody: + content: + application/json: + schema: + items: + additionalProperties: true + type: object + type: array + title: Rows + required: true /v1beta/datasetio/iterrows/{dataset_id}: get: + responses: + '200': + description: A PaginatedResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Datasetio summary: Iterrows + description: |- + Get a paginated list of rows from a dataset. + + Uses offset-based pagination where: + - start_index: The starting index (0-based). If None, starts from beginning. + - limit: Number of items to return. If None or -1, returns all items. + + The response includes: + - data: List of items for the current page. + - has_more: Whether there are more items available after this set. 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: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: start_index + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Start Index - name: dataset_id in: path required: true @@ -2372,16 +3280,38 @@ paths: description: 'Path parameter: dataset_id' /v1beta/datasets: get: + responses: + '200': + description: A ListDatasetsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListDatasetsResponse' + '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' tags: - Datasets summary: List Datasets + description: List all datasets. operationId: list_datasets_v1beta_datasets_get + post: responses: '200': - description: Successful Response + description: A Dataset. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Dataset' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2394,36 +3324,52 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - post: tags: - Datasets summary: Register Dataset + description: Register a new 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1BetaDatasetsPostRequestLoose' + required: true deprecated: true /v1beta/datasets/{dataset_id}: get: + responses: + '200': + description: A Dataset. + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + '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' tags: - Datasets summary: Get Dataset + description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get + parameters: + - name: dataset_id + in: path + required: true + schema: + type: string + description: 'Path parameter: dataset_id' + delete: responses: '200': description: Successful Response @@ -2442,37 +3388,11 @@ paths: 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 + description: Unregister a dataset by its ID. 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 @@ -2480,12 +3400,34 @@ paths: schema: type: string description: 'Path parameter: dataset_id' + deprecated: true /v1alpha/eval/benchmarks: get: + responses: + '200': + description: A ListBenchmarksResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/ListBenchmarksResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Benchmarks summary: List Benchmarks + description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get + post: responses: '200': description: Successful Response @@ -2493,53 +3435,38 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - post: + description: Default Response tags: - Benchmarks summary: Register Benchmark + description: Register a 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Body_register_benchmark_v1alpha_eval_benchmarks_post' deprecated: true /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 + description: A Benchmark. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Benchmark' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2552,6 +3479,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Benchmarks + summary: Get Benchmark + description: Get a benchmark by its ID. + operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get parameters: - name: benchmark_id in: path @@ -2560,16 +3492,46 @@ paths: type: string description: 'Path parameter: 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' tags: - Benchmarks summary: Unregister Benchmark + description: Unregister a benchmark. operationId: unregister_benchmark_v1alpha_eval_benchmarks__benchmark_id__delete + parameters: + - name: benchmark_id + in: path + required: true + schema: + type: string + description: 'Path parameter: benchmark_id' + deprecated: true + /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: + post: responses: '200': - description: Successful Response + description: EvaluateResponse object containing generations and scores. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/EvaluateResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2582,26 +3544,33 @@ paths: 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/{benchmark_id}/evaluations: - post: tags: - Eval summary: Evaluate Rows + description: Evaluate a list of rows on a benchmark. operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post + parameters: + - name: benchmark_id + in: path + required: true + schema: + type: string + description: 'Path parameter: benchmark_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest' + required: true + /v1alpha/eval/benchmarks/{benchmark_id}/jobs: + post: responses: '200': - description: Successful Response + description: The job that was created to run the evaluation. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Job' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2614,37 +3583,11 @@ paths: 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: - post: tags: - Eval summary: Run Eval + description: Run an evaluation on a benchmark. 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 @@ -2652,18 +3595,21 @@ paths: schema: type: string description: 'Path parameter: benchmark_id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BenchmarkConfig' + required: true /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 + description: The status of the evaluation job. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/Job' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2676,6 +3622,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Status + description: Get the status of a job. + operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get parameters: - name: benchmark_id in: path @@ -2690,10 +3641,6 @@ paths: 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 @@ -2712,6 +3659,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Cancel + description: Cancel a job. + operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete parameters: - name: benchmark_id in: path @@ -2727,16 +3679,13 @@ paths: 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 + description: The result of the job. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/EvaluateResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2749,6 +3698,11 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' + tags: + - Eval + summary: Job Result + description: Get the result of a job. + operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get parameters: - name: benchmark_id in: path @@ -2764,34 +3718,71 @@ paths: description: 'Path parameter: job_id' /v1alpha/inference/rerank: post: + responses: + '200': + description: RerankResponse with indices sorted by relevance score (descending). + content: + application/json: + schema: + $ref: '#/components/schemas/RerankResponse' + '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' tags: - Inference summary: Rerank + description: Rerank a list of documents based on their relevance to a query. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaInferenceRerankPostRequest' + required: true /v1alpha/post-training/job/artifacts: get: + responses: + '200': + description: A PostTrainingJobArtifactsResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Post Training summary: Get Training Job Artifacts + description: Get the artifacts of a training job. operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid + /v1alpha/post-training/job/cancel: + post: responses: '200': description: Successful Response @@ -2799,53 +3790,71 @@ paths: application/json: schema: {} '400': - description: Bad Request $ref: '#/components/responses/BadRequest400' + description: Bad Request '429': - description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests '500': - description: Internal Server Error $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error default: - description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/job/cancel: - post: + description: Default Response tags: - Post Training summary: Cancel Training Job + description: Cancel a 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' + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid /v1alpha/post-training/job/status: get: + responses: + '200': + description: A PostTrainingJobStatusResponse. + content: + application/json: + schema: + $ref: '#/components/schemas/PostTrainingJobStatusResponse' + '400': + $ref: '#/components/responses/BadRequest400' + description: Bad Request + '429': + $ref: '#/components/responses/TooManyRequests429' + description: Too Many Requests + '500': + $ref: '#/components/responses/InternalServerError500' + description: Internal Server Error + default: + $ref: '#/components/responses/DefaultError' + description: Default Response tags: - Post Training summary: Get Training Job Status + description: Get the status of a training job. operationId: get_training_job_status_v1alpha_post_training_job_status_get + parameters: + - name: job_uuid + in: query + required: true + schema: + type: string + title: Job Uuid + /v1alpha/post-training/jobs: + get: responses: '200': - description: Successful Response + description: A ListPostTrainingJobsResponse. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/ListPostTrainingJobsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2858,18 +3867,20 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/jobs: - get: tags: - Post Training summary: Get Training Jobs + description: Get all training jobs. operationId: get_training_jobs_v1alpha_post_training_jobs_get + /v1alpha/post-training/preference-optimize: + post: responses: '200': - description: Successful Response + description: A PostTrainingJob. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/PostTrainingJob' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2882,18 +3893,26 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/preference-optimize: - post: tags: - Post Training summary: Preference Optimize + description: Run preference optimization of a model. operationId: preference_optimize_v1alpha_post_training_preference_optimize_post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaPostTrainingPreferenceOptimizePostRequest' + required: true + /v1alpha/post-training/supervised-fine-tune: + post: responses: '200': - description: Successful Response + description: A PostTrainingJob. content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/PostTrainingJob' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2906,68 +3925,18 @@ paths: default: description: Default Response $ref: '#/components/responses/DefaultError' - /v1alpha/post-training/supervised-fine-tune: - post: tags: - Post Training summary: Supervised Fine Tune + description: Run supervised fine-tuning of a model. 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V1AlphaPostTrainingSupervisedFineTunePostRequest' + required: true 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: Error: description: Error response from the API. Roughly follows RFC 7807. @@ -2993,63 +3962,61 @@ components: title: Error type: object ListBatchesResponse: - description: Response containing a list of batch objects. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: - description: List of batch objects items: $ref: '#/components/schemas/Batch' - title: Data type: array + title: Data + description: List of batch objects 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 + title: Has More + description: Whether there are more batches available + default: false + type: object required: - data title: ListBatchesResponse - type: object + description: Response containing a list of batch objects. Batch: - additionalProperties: true properties: id: + type: string title: Id - type: string completion_window: + type: string title: Completion Window - type: string created_at: - title: Created At type: integer + title: Created At endpoint: + type: string title: Endpoint - type: string input_file_id: - title: Input File Id type: string + title: Input File Id object: + type: string const: batch title: Object - type: string status: + type: string enum: - validating - failed @@ -3060,90 +4027,76 @@ components: - 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 + additionalProperties: true + type: object required: - id - completion_window @@ -3153,36 +4106,42 @@ components: - object - status title: Batch - type: object + Order: + type: string + enum: + - asc + - desc + title: Order + description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: - description: Response from listing OpenAI-compatible chat completions. properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse - type: object + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: @@ -3216,19 +4175,19 @@ components: title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionContentPartImageParam: - description: Image content part for OpenAI-compatible chat completion messages. properties: type: - const: image_url - default: image_url - title: Type type: string + const: image_url + title: Type + default: image_url image_url: $ref: '#/components/schemas/OpenAIImageURL' + type: object required: - image_url title: OpenAIChatCompletionContentPartImageParam - type: object + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -3245,139 +4204,130 @@ components: title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIChatCompletionContentPartTextParam: - description: Text content part for OpenAI-compatible chat completion messages. properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: OpenAIChatCompletionContentPartTextParam - type: object + description: Text content part for OpenAI-compatible chat completion messages. 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 + const: function + title: Type + default: function function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' - nullable: true title: OpenAIChatCompletionToolCallFunction - title: OpenAIChatCompletionToolCall type: object + title: OpenAIChatCompletionToolCall + description: Tool call specification for OpenAI-compatible chat completion responses. 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 + title: OpenAIChatCompletionToolCallFunction + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: - description: Usage information for OpenAI chat completion. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer completion_tokens: + type: integer title: Completion Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage - type: object + description: Usage information for OpenAI chat completion. 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + title: OpenAIUserMessageParam-Output | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' finish_reason: - title: Finish Reason type: string + title: Finish Reason index: - title: Index type: integer + title: Index logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' - nullable: true title: OpenAIChoiceLogprobs + type: object required: - message - finish_reason - index title: OpenAIChoice - type: object + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. properties: content: anyOf: @@ -3385,24 +4335,22 @@ components: $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 + title: OpenAIChoiceLogprobs + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: - description: A message from the developer in an OpenAI-compatible chat completion request. properties: role: - const: developer - default: developer - title: Role type: string + const: developer + title: Role + default: developer content: anyOf: - type: string @@ -3415,58 +4363,54 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAIDeveloperMessageParam - type: object + description: A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: properties: type: - const: file - default: file - title: Type type: string + const: file + title: Type + default: file file: $ref: '#/components/schemas/OpenAIFileFile' + type: object 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 + title: OpenAIFileFile OpenAIImageURL: - description: Image URL specification for OpenAI-compatible chat completion messages. properties: url: - title: Url type: string + title: Url detail: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - url title: OpenAIImageURL - type: object + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: discriminator: mapping: @@ -3489,13 +4433,12 @@ components: title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAISystemMessageParam: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string @@ -3508,12 +4451,36 @@ components: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - content title: OpenAISystemMessageParam - type: object + description: A system message providing instructions or context to the model. OpenAITokenLogProb: + properties: + token: + type: string + title: Token + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + logprob: + type: number + title: Logprob + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + type: array + title: Top Logprobs + type: object + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb description: |- The log probability for a token from an OpenAI-compatible chat completion response. @@ -3521,42 +4488,16 @@ components: :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 OpenAIToolMessageParam: - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. properties: role: + type: string const: tool - default: tool title: Role - type: string + default: tool tool_call_id: - title: Tool Call Id type: string + title: Tool Call Id content: anyOf: - type: string @@ -3565,37 +4506,37 @@ components: type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] + type: object required: - tool_call_id - content title: OpenAIToolMessageParam - type: object + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. 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 + title: Token bytes: anyOf: - items: type: integer type: array - type: 'null' - nullable: true logprob: - title: Logprob type: number + title: Logprob + type: object required: - token - logprob title: OpenAITopLogProb - type: object + 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 OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -3635,11 +4576,10 @@ components: title: OpenAIUserMessageParam type: object OpenAIJSONSchema: - description: JSON schema specification for OpenAI-compatible structured response format. properties: name: - title: Name type: string + title: Name description: anyOf: - type: string @@ -3653,32 +4593,33 @@ components: - additionalProperties: true type: object - type: 'null' + type: object title: OpenAIJSONSchema - type: object + description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: - description: JSON object response format for OpenAI-compatible chat completion requests. properties: type: + type: string const: json_object - default: json_object title: Type - type: string - title: OpenAIResponseFormatJSONObject + default: json_object type: object + title: OpenAIResponseFormatJSONObject + description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: - description: JSON schema response format for OpenAI-compatible chat completion requests. properties: type: - const: json_schema - default: json_schema - title: Type type: string + const: json_schema + title: Type + default: json_schema json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' + type: object required: - json_schema title: OpenAIResponseFormatJSONSchema - type: object + description: JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: discriminator: mapping: @@ -3695,52 +4636,49 @@ components: title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject OpenAIResponseFormatText: - description: Text response format for OpenAI-compatible chat completion requests. properties: type: - const: text - default: text - title: Type type: string - title: OpenAIResponseFormatText + const: text + title: Type + default: text type: object + title: OpenAIResponseFormatText + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible chat completion endpoint. properties: model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array minItems: 1 title: Messages - type: array frequency_penalty: anyOf: - type: number - type: 'null' - nullable: true function_call: anyOf: - type: string @@ -3748,7 +4686,6 @@ components: type: object - type: 'null' title: string | object - nullable: true functions: anyOf: - items: @@ -3756,68 +4693,58 @@ components: 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: + - oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject + discriminator: + propertyName: type + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format - nullable: true seed: anyOf: - type: integer - type: 'null' - nullable: true stop: anyOf: - type: string @@ -3827,23 +4754,19 @@ components: 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 @@ -3851,7 +4774,6 @@ components: type: object - type: 'null' title: string | object - nullable: true tools: anyOf: - items: @@ -3859,63 +4781,60 @@ components: 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 + additionalProperties: true + type: object required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: - description: Response from an OpenAI-compatible chat completion request. properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' - nullable: true title: OpenAIChatCompletionUsage + type: object required: - id - choices - created - model title: OpenAIChatCompletion - type: object + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: @@ -4011,55 +4930,55 @@ components: OpenAICompletionWithInputMessages: properties: id: - title: Id type: string + title: Id choices: items: $ref: '#/components/schemas/OpenAIChoice' - title: Choices type: array + title: Choices object: + type: string const: chat.completion - default: chat.completion title: Object - type: string + default: chat.completion created: - title: Created type: integer + title: Created model: - title: Model type: string + title: Model 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/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' + title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Input Messages + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Output' + title: OpenAIUserMessageParam-Output | ... (5 variants) type: array + title: Input Messages + type: object required: - id - choices @@ -4067,14 +4986,11 @@ components: - model - input_messages title: OpenAICompletionWithInputMessages - type: object OpenAICompletionRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible completion endpoint. properties: model: - title: Model type: string + title: Model prompt: anyOf: - type: string @@ -4097,49 +5013,40 @@ components: 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 @@ -4149,44 +5056,66 @@ components: 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 + additionalProperties: true + type: object required: - model - prompt title: OpenAICompletionRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: + properties: + id: + type: string + title: Id + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + type: array + title: Choices + created: + type: integer + title: Created + model: + type: string + title: Model + object: + type: string + const: text_completion + title: Object + default: text_completion + type: object + required: + - id + - choices + - created + - model + title: OpenAICompletion description: |- Response from an OpenAI-compatible completion request. @@ -4195,34 +5124,29 @@ components: :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 OpenAICompletionChoice: + properties: + finish_reason: + type: string + title: Finish Reason + text: + type: string + title: Text + index: + type: integer + title: Index + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + title: OpenAIChoiceLogprobs + type: object + required: + - finish_reason + - text + - index + title: OpenAICompletionChoice description: |- A choice from an OpenAI-compatible completion response. @@ -4230,29 +5154,6 @@ components: :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 ConversationItem: discriminator: mapping: @@ -4287,54 +5188,55 @@ components: title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) OpenAIResponseAnnotationCitation: - description: URL citation annotation for referencing external web resources. properties: type: + type: string const: url_citation - default: url_citation title: Type - type: string + default: url_citation end_index: + type: integer title: End Index - type: integer start_index: - title: Start Index type: integer + title: Start Index title: + type: string title: Title - type: string url: - title: Url type: string + title: Url + type: object required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation - type: object + description: URL citation annotation for referencing external web resources. OpenAIResponseAnnotationContainerFileCitation: properties: type: + type: string const: container_file_citation - default: container_file_citation title: Type - type: string + default: container_file_citation container_id: + type: string title: Container Id - type: string end_index: + type: integer title: End Index - type: integer file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename start_index: - title: Start Index type: integer + title: Start Index + type: object required: - container_id - end_index @@ -4342,48 +5244,47 @@ components: - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation - type: object OpenAIResponseAnnotationFileCitation: - description: File citation annotation for referencing specific files in response content. properties: type: + type: string const: file_citation - default: file_citation title: Type - type: string + default: file_citation file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename index: - title: Index type: integer + title: Index + type: object required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation - type: object + description: File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: properties: type: + type: string const: file_path - default: file_path title: Type - type: string + default: file_path file_id: - title: File Id type: string + title: File Id index: - title: Index type: integer + title: Index + type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath - type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -4403,49 +5304,47 @@ components: title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: - description: Refusal content within a streamed response part. properties: type: + type: string const: refusal - default: refusal title: Type - type: string + default: refusal refusal: - title: Refusal type: string + title: Refusal + type: object required: - refusal title: OpenAIResponseContentPartRefusal - type: object + description: Refusal content within a streamed response part. OpenAIResponseInputFunctionToolCallOutput: - description: This represents the output of a function call that gets passed back to the model. properties: call_id: + type: string title: Call Id - type: string output: + type: string title: Output - type: string type: - const: function_call_output - default: function_call_output - title: Type type: string + const: function_call_output + title: Type + default: function_call_output id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput - type: object + description: This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: discriminator: mapping: @@ -4462,134 +5361,126 @@ components: title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseInputMessageContentFile: - description: File content for input messages in OpenAI response format. properties: type: - const: input_file - default: input_file - title: Type type: string + const: input_file + title: Type + default: input_file 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 + title: OpenAIResponseInputMessageContentFile + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: - description: Image content for input messages in OpenAI response format. properties: detail: - default: auto title: Detail + default: auto type: string enum: - low - high - auto type: - const: input_image - default: input_image - title: Type type: string + const: input_image + title: Type + default: input_image file_id: anyOf: - type: string - type: 'null' - nullable: true image_url: anyOf: - type: string - type: 'null' - nullable: true - title: OpenAIResponseInputMessageContentImage type: object + title: OpenAIResponseInputMessageContentImage + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: - description: Text content for input messages in OpenAI response format. properties: text: + type: string title: Text - type: string type: - const: input_text - default: input_text - title: Type type: string + const: input_text + title: Type + default: input_text + type: object required: - text title: OpenAIResponseInputMessageContentText - type: object + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: - description: A request for human approval of a tool invocation. properties: arguments: + type: string title: Arguments - type: string id: + type: string title: Id - type: string name: + type: string title: Name - type: string server_label: + type: string title: Server Label - type: string type: - const: mcp_approval_request - default: mcp_approval_request - title: Type type: string + const: mcp_approval_request + title: Type + default: mcp_approval_request + type: object required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest - type: object + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: - description: A response to an MCP approval request. properties: approval_request_id: + type: string title: Approval Request Id - type: string approve: - title: Approve type: boolean + title: Approve type: - const: mcp_approval_response - default: mcp_approval_response - title: Type type: string + const: mcp_approval_response + title: Type + default: mcp_approval_response id: anyOf: - type: string - type: 'null' - nullable: true reason: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse - type: object + description: A response to an MCP approval request. OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -4676,22 +5567,15 @@ components: OpenAIResponseOutputMessageContentOutputText: properties: text: + type: string title: Text - type: string type: - const: output_text - default: output_text - title: Type type: string + const: output_text + title: Type + default: output_text 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 @@ -4701,176 +5585,177 @@ components: title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath + discriminator: + propertyName: type + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - title: Annotations type: array + title: Annotations + type: object required: - text title: OpenAIResponseOutputMessageContentOutputText - type: object OpenAIResponseOutputMessageFileSearchToolCall: - description: File search tool call output message for OpenAI responses. properties: id: - title: Id type: string + title: Id queries: items: type: string - title: Queries type: array + title: Queries status: + type: string title: Status - type: string type: - const: file_search_call - default: file_search_call - title: Type type: string + const: file_search_call + title: Type + default: file_search_call results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' - nullable: true + type: object required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall - type: object + description: File search tool call output message for OpenAI responses. OpenAIResponseOutputMessageFunctionToolCall: - description: Function tool call output message for OpenAI responses. properties: call_id: + type: string title: Call Id - type: string name: + type: string title: Name - type: string arguments: + type: string title: Arguments - type: string type: - const: function_call - default: function_call - title: Type type: string + const: function_call + title: Type + default: function_call id: anyOf: - type: string - type: 'null' - nullable: true status: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall - type: object + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: - description: Model Context Protocol (MCP) call output message for OpenAI responses. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_call - default: mcp_call title: Type - type: string + default: mcp_call arguments: + type: string title: Arguments - type: string name: + type: string title: Name - type: string server_label: - title: Server Label type: string + title: Server Label error: anyOf: - type: string - type: 'null' - nullable: true output: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall - type: object + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: - description: MCP list tools output message containing available tools from an MCP server. properties: id: + type: string title: Id - type: string type: + type: string const: mcp_list_tools - default: mcp_list_tools title: Type - type: string + default: mcp_list_tools server_label: - title: Server Label type: string + title: Server Label tools: items: $ref: '#/components/schemas/MCPListToolsTool' - title: Tools type: array + title: Tools + type: object required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools - type: object + description: MCP list tools output message containing available tools from an MCP server. OpenAIResponseOutputMessageWebSearchToolCall: - description: Web search tool call output message for OpenAI responses. properties: id: + type: string title: Id - type: string status: + type: string title: Status - type: string type: - const: web_search_call - default: web_search_call - title: Type type: string + const: web_search_call + title: Type + default: web_search_call + type: object required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall - type: object + description: Web search tool call output message for OpenAI responses. Conversation: - description: OpenAI-compatible conversation object. properties: id: - description: The unique ID of the conversation. + type: string title: Id - type: string + description: The unique ID of the conversation. object: - const: conversation - default: conversation - description: The object type, which is always conversation. - title: Object type: string + const: conversation + title: Object + description: The object type, which is always conversation. + default: conversation created_at: - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - title: Created At type: integer + title: Created At + description: The time at which the conversation was created, measured in seconds since the Unix epoch. metadata: anyOf: - additionalProperties: @@ -4878,7 +5763,6 @@ components: 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: @@ -4887,59 +5771,45 @@ components: 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 + type: object required: - id - created_at title: Conversation - type: object + description: OpenAI-compatible conversation object. ConversationDeletedResource: - description: Response for deleted conversation. properties: id: - description: The deleted conversation identifier + type: string title: Id - type: string + description: The deleted conversation identifier object: - default: conversation.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationDeletedResource - type: object + description: Response for deleted conversation. ConversationItemList: - description: List of conversation items with pagination. properties: object: - default: list - description: Object type - title: Object type: string + title: Object + description: Object type + default: list 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -4956,58 +5826,68 @@ components: title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - title: Data + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (9 variants) type: array + title: Data + description: List of conversation items 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 + title: Has More + description: Whether there are more items available + default: false + type: object required: - data title: ConversationItemList - type: object + description: List of conversation items with pagination. ConversationItemDeletedResource: - description: Response for deleted conversation item. properties: id: - description: The deleted item identifier + type: string title: Id - type: string + description: The deleted item identifier object: - default: conversation.item.deleted - description: Object type - title: Object type: string + title: Object + description: Object type + default: conversation.item.deleted deleted: - default: true - description: Whether the object was deleted - title: Deleted type: boolean + title: Deleted + description: Whether the object was deleted + default: true + type: object required: - id title: ConversationItemDeletedResource - type: object + description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: - additionalProperties: true - description: Request parameters for OpenAI-compatible embeddings endpoint. properties: model: - title: Model type: string + title: Model input: anyOf: - type: string @@ -5025,25 +5905,24 @@ components: anyOf: - type: integer - type: 'null' - nullable: true user: anyOf: - type: string - type: 'null' - nullable: true + additionalProperties: true + type: object required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody - type: object + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: - description: A single embedding data object from an OpenAI-compatible embeddings response. properties: object: - const: embedding - default: embedding - title: Object type: string + const: embedding + title: Object + default: embedding embedding: anyOf: - items: @@ -5053,112 +5932,113 @@ components: - type: string title: list[number] | string index: - title: Index type: integer + title: Index + type: object required: - embedding - index title: OpenAIEmbeddingData - type: object + description: A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: - description: Usage information for an OpenAI-compatible embeddings response. properties: prompt_tokens: + type: integer title: Prompt Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens + type: object required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage - type: object + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: - description: Response from an OpenAI-compatible embeddings request. properties: object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' - title: Data type: array + title: Data model: - title: Model type: string + title: Model usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' + type: object required: - data - model - usage title: OpenAIEmbeddingsResponse - type: object + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: - description: Valid purpose values for OpenAI Files API. + type: string enum: - assistants - batch title: OpenAIFilePurpose - type: string + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: - description: Response for listing files in OpenAI Files API. properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse - type: object + description: Response for listing files in OpenAI Files API. OpenAIFileObject: - description: OpenAI File object as defined in the OpenAI Files API. properties: object: + type: string const: file - default: file title: Object - type: string + default: file id: + type: string title: Id - type: string bytes: + type: integer title: Bytes - type: integer created_at: + type: integer title: Created At - type: integer expires_at: - title: Expires At type: integer + title: Expires At filename: - title: Filename type: string + title: Filename purpose: $ref: '#/components/schemas/OpenAIFilePurpose' + type: object required: - id - bytes @@ -5167,90 +6047,119 @@ components: - filename - purpose title: OpenAIFileObject - type: object + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: + properties: + anchor: + type: string + const: created_at + title: Anchor + seconds: + type: integer + maximum: 2592000.0 + minimum: 3600.0 + title: Seconds + type: object + required: + - anchor + - seconds + title: 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 OpenAIFileDeleteResponse: - description: Response for deleting a file in OpenAI Files API. properties: id: + type: string title: Id - type: string object: - const: file - default: file - title: Object type: string + const: file + title: Object + default: file deleted: - title: Deleted type: boolean + title: Deleted + type: object required: - id - deleted title: OpenAIFileDeleteResponse + description: Response for deleting a file in OpenAI Files API. + Response: + title: Response type: object HealthInfo: - description: Health status information for the service. properties: status: $ref: '#/components/schemas/HealthStatus' + type: object required: - status title: HealthInfo - type: object + description: Health status information for the service. RouteInfo: - description: Information about an API route including its path, method, and implementing providers. properties: route: + type: string title: Route - type: string method: - title: Method type: string + title: Method provider_types: items: type: string - title: Provider Types type: array + title: Provider Types + type: object required: - route - method - provider_types title: RouteInfo - type: object + description: Information about an API route including its path, method, and implementing providers. ListRoutesResponse: - description: Response containing a list of all available API routes. properties: data: items: $ref: '#/components/schemas/RouteInfo' - title: Data type: array + title: Data + type: object required: - data title: ListRoutesResponse - type: object + description: Response containing a list of all available API routes. OpenAIModel: + properties: + id: + type: string + title: Id + object: + type: string + const: model + title: Object + default: model + created: + type: integer + title: Created + owned_by: + type: string + title: Owned By + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - id + - created + - owned_by + title: OpenAIModel description: |- A model from OpenAI. @@ -5259,120 +6168,90 @@ components: :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 + title: Data + type: object required: - data title: OpenAIListModelsResponse - type: object 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: model - default: model - title: Type type: string + const: model + title: Type + default: model metadata: additionalProperties: true - description: Any additional metadata for this model - title: Metadata type: object + title: Metadata + description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm + type: object required: - identifier - provider_id title: Model - type: object + description: A model resource representing an AI model registered in Llama Stack. ModelType: - description: Enumeration of supported model types in Llama Stack. + type: string enum: - llm - embedding - rerank title: ModelType - type: string + description: Enumeration of supported model types in Llama Stack. ModerationObject: - description: A moderation object. properties: id: + type: string title: Id - type: string model: - title: Model type: string + title: Model results: items: $ref: '#/components/schemas/ModerationObjectResults' - title: Results type: array + title: Results + type: object required: - id - model - results title: ModerationObject - type: object - ModerationObjectResults: description: A moderation object. + ModerationObjectResults: properties: flagged: - title: Flagged type: boolean + title: Flagged categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' - nullable: true category_applied_input_types: anyOf: - additionalProperties: @@ -5381,93 +6260,90 @@ components: 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 + title: Metadata + type: object required: - flagged title: ModerationObjectResults - type: object + description: A moderation 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 + minimum: 1.0 + title: Version + description: Version (integer starting at 1, incremented on save) prompt_id: - description: Unique identifier in format 'pmpt_<48-digit-hash>' - title: Prompt Id type: string + title: Prompt Id + description: Unique identifier in format 'pmpt_<48-digit-hash>' variables: - description: List of variable names that can be used in the prompt template items: type: string - title: Variables type: array + title: Variables + description: List of variable names that can be used in the prompt template is_default: - default: false - description: Boolean indicating whether this version is the default version - title: Is Default type: boolean + title: Is Default + description: Boolean indicating whether this version is the default version + default: false + type: object required: - version - prompt_id title: Prompt - type: object + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. ListPromptsResponse: - description: Response model to list prompts. properties: data: items: $ref: '#/components/schemas/Prompt' - title: Data type: array + title: Data + type: object required: - data title: ListPromptsResponse - type: object + description: Response model to list prompts. ProviderInfo: - description: Information about a registered provider including its configuration and health status. properties: api: + type: string title: Api - type: string provider_id: + type: string title: Provider Id - type: string provider_type: - title: Provider Type type: string + title: Provider Type config: additionalProperties: true - title: Config type: object + title: Config health: additionalProperties: true - title: Health type: object + title: Health + type: object required: - api - provider_id @@ -5475,62 +6351,62 @@ components: - config - health title: ProviderInfo - type: object + description: Information about a registered provider including its configuration and health status. ListProvidersResponse: - description: Response containing a list of all available providers. properties: data: items: $ref: '#/components/schemas/ProviderInfo' - title: Data type: array + title: Data + type: object required: - data title: ListProvidersResponse - type: object + description: Response containing a list of all available providers. ListOpenAIResponseObject: - description: Paginated list of OpenAI response objects with navigation metadata. properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More first_id: + type: string title: First Id - type: string last_id: + type: string title: Last Id - type: string object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject - type: object + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: - description: Error details for failed OpenAI response requests. properties: code: + type: string title: Code - type: string message: - title: Message type: string + title: Message + type: object required: - code - message title: OpenAIResponseError - type: object + description: Error details for failed OpenAI response requests. OpenAIResponseInput: anyOf: - discriminator: @@ -5567,29 +6443,27 @@ components: title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage OpenAIResponseInputToolFileSearch: - description: File search tool configuration for OpenAI response inputs. properties: type: - const: file_search - default: file_search - title: Type type: string + const: file_search + title: Type + default: file_search vector_store_ids: items: type: string - title: Vector Store Ids type: array + title: Vector Store Ids filters: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true max_num_results: anyOf: - - maximum: 50 - minimum: 1 - type: integer + - type: integer + maximum: 50.0 + minimum: 1.0 - type: 'null' default: 10 ranking_options: @@ -5597,28 +6471,26 @@ components: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' - nullable: true title: SearchRankingOptions + type: object required: - vector_store_ids title: OpenAIResponseInputToolFileSearch - type: object + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: - description: Function tool configuration for OpenAI response inputs. properties: type: + type: string const: function - default: function title: Type - type: string + default: function name: - title: Name type: string + title: Name description: anyOf: - type: string - type: 'null' - nullable: true parameters: anyOf: - additionalProperties: true @@ -5628,18 +6500,17 @@ components: anyOf: - type: boolean - type: 'null' - nullable: true + type: object required: - name - parameters title: OpenAIResponseInputToolFunction - type: object + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: - description: Web search tool configuration for OpenAI response inputs. properties: type: - default: web_search title: Type + default: web_search type: string enum: - web_search @@ -5648,51 +6519,40 @@ components: - web_search_2025_08_26 search_context_size: anyOf: - - pattern: ^low|medium|high$ - type: string + - type: string + pattern: ^low|medium|high$ - type: 'null' default: medium - title: OpenAIResponseInputToolWebSearch type: object + title: OpenAIResponseInputToolWebSearch + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: - description: OpenAI response object extended with input context information. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5705,33 +6565,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -5741,20 +6608,9 @@ components: 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 @@ -5764,48 +6620,43 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -5818,16 +6669,27 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Input + type: object required: - created_at - id @@ -5836,7 +6698,7 @@ components: - status - input title: OpenAIResponseObjectWithInput - type: object + description: OpenAI response object extended with input context information. OpenAIResponseOutput: discriminator: mapping: @@ -5865,20 +6727,13 @@ components: title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) OpenAIResponsePrompt: - description: OpenAI compatible Prompt object that is used in OpenAI responses. properties: id: - title: Id type: string + title: Id 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 @@ -5886,31 +6741,35 @@ components: title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' - nullable: true version: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - id title: OpenAIResponsePrompt - type: object + description: OpenAI compatible Prompt object that is used in OpenAI responses. 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 + title: OpenAIResponseText + description: Text response configuration for OpenAI responses. OpenAIResponseTool: discriminator: mapping: @@ -5933,16 +6792,15 @@ components: title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: - title: Server Label type: string + title: Server Label allowed_tools: anyOf: - items: @@ -5953,43 +6811,41 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label title: OpenAIResponseToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. OpenAIResponseUsage: - description: Usage information for OpenAI response. properties: input_tokens: + type: integer title: Input Tokens - type: integer output_tokens: + type: integer title: Output Tokens - type: integer total_tokens: - title: Total Tokens type: integer + title: Total Tokens 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 + type: object required: - input_tokens - output_tokens - total_tokens title: OpenAIResponseUsage - type: object + description: Usage information for OpenAI response. ResponseGuardrailSpec: description: Specification for a guardrail to apply during response generation. properties: @@ -6022,40 +6878,37 @@ components: title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseInputToolMCP: - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. properties: type: + type: string const: mcp - default: mcp title: Type - type: string + default: mcp server_label: + type: string title: Server Label - type: string server_url: - title: Server Url type: string + title: Server Url 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 + - type: string + const: always + - type: string + const: never - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter - default: never title: string | ApprovalFilter + default: never allowed_tools: anyOf: - items: @@ -6066,51 +6919,39 @@ components: title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter - nullable: true + type: object required: - server_label - server_url title: OpenAIResponseInputToolMCP - type: object + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseObject: - description: Complete OpenAI response object containing generation results and metadata. properties: created_at: - title: Created At type: integer + title: Created At error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' - nullable: true title: OpenAIResponseError id: + type: string title: Id - type: string model: + type: string title: Model - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response 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/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -6123,33 +6964,40 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) - title: Output + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (7 variants) type: array + title: Output parallel_tool_calls: - default: false - title: Parallel Tool Calls type: boolean + title: Parallel Tool Calls + default: false 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 + title: Status temperature: anyOf: - type: number - type: 'null' - nullable: true text: $ref: '#/components/schemas/OpenAIResponseText' default: @@ -6159,20 +7007,9 @@ components: 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 @@ -6182,32 +7019,38 @@ components: title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP + discriminator: + propertyName: type + 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' 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 + type: object required: - created_at - id @@ -6215,7 +7058,7 @@ components: - output - status title: OpenAIResponseObject - type: object + description: Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: @@ -7379,43 +8222,32 @@ components: title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: - description: Response object confirming deletion of an OpenAI response. properties: id: + type: string title: Id - type: string object: - const: response - default: response - title: Object type: string + const: response + title: Object + default: response deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: OpenAIDeleteResponseObject - type: object + description: Response object confirming deletion of an OpenAI response. 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 + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' @@ -7428,39 +8260,48 @@ components: title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - title: OpenAIResponseMessage | ... (7 variants) + discriminator: + propertyName: type + 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-Output' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Output | ... (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 + - $ref: '#/components/schemas/OpenAIResponseMessage-Output' + title: OpenAIResponseMessage-Output + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array + title: Data object: - const: list - default: list - title: Object type: string + const: list + title: Object + default: list + type: object required: - data title: ListOpenAIResponseInputItem - type: object + description: List container for OpenAI response input items. 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 + title: RunShieldResponse + description: Response from running a safety shield. SafetyViolation: - description: Details of a safety violation detected by content moderation. properties: violation_level: $ref: '#/components/schemas/ViolationLevel' @@ -7468,25 +8309,25 @@ components: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - title: Metadata type: object + title: Metadata + type: object required: - violation_level title: SafetyViolation - type: object + description: Details of a safety violation detected by content moderation. ViolationLevel: - description: Severity level of a safety violation. + type: string enum: - info - warn - error title: ViolationLevel - type: string + description: Severity level of a safety violation. AggregationFunctionType: - description: Types of aggregation functions for scoring results. + type: string enum: - average - weighted_average @@ -7494,193 +8335,176 @@ components: - categorical_count - accuracy title: AggregationFunctionType - type: string + description: Types of aggregation functions for scoring results. ArrayType: - description: Parameter type for array values. properties: type: + type: string const: array - default: array title: Type - type: string - title: ArrayType + default: array type: object + title: ArrayType + description: Parameter type for array values. BasicScoringFnParams: - description: Parameters for basic scoring function configuration. properties: type: - const: basic - default: basic - title: Type type: string + const: basic + title: Type + default: basic aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object title: BasicScoringFnParams - type: object + description: Parameters for basic scoring function configuration. BooleanType: - description: Parameter type for boolean values. properties: type: + type: string const: boolean + title: Type default: boolean - title: Type - type: string + type: object title: BooleanType - type: object + description: Parameter type for boolean values. ChatCompletionInputType: - description: Parameter type for chat completion input. properties: type: + type: string const: chat_completion_input + title: Type default: chat_completion_input - title: Type - type: string + type: object title: ChatCompletionInputType - type: object + description: Parameter type for chat completion input. CompletionInputType: - description: Parameter type for completion input. properties: type: + type: string const: completion_input + title: Type default: completion_input - title: Type - type: string + type: object title: CompletionInputType - type: object + description: Parameter type for completion input. JsonType: - description: Parameter type for JSON values. properties: type: + type: string const: json - default: json title: Type - type: string - title: JsonType + default: json type: object + title: JsonType + description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: - description: Parameters for LLM-as-judge scoring function configuration. properties: type: + type: string const: llm_as_judge - default: llm_as_judge title: Type - type: string + default: llm_as_judge judge_model: - title: Judge Model type: string + title: Judge Model 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 + title: Judge Score Regexes + description: Regexes to extract the answer from generated response aggregation_functions: - description: Aggregation functions to apply to the scores of each row items: $ref: '#/components/schemas/AggregationFunctionType' - title: Aggregation Functions type: array + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row + type: object required: - judge_model title: LLMAsJudgeScoringFnParams - type: object + description: Parameters for LLM-as-judge scoring function configuration. NumberType: - description: Parameter type for numeric values. properties: type: + type: string const: number + title: Type default: number - title: Type - type: string + type: object title: NumberType - type: object + description: Parameter type for numeric values. ObjectType: - description: Parameter type for object values. properties: type: + type: string const: object - default: object title: Type - type: string - title: ObjectType + default: object type: object + title: ObjectType + description: Parameter type for object values. RegexParserScoringFnParams: - description: Parameters for regex parser scoring function configuration. properties: type: - const: regex_parser - default: regex_parser - title: Type type: string + const: regex_parser + title: Type + default: regex_parser parsing_regexes: - description: Regex to extract the answer from generated response items: type: string - title: Parsing Regexes type: array + title: Parsing Regexes + description: Regex to extract the answer from generated response 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 + title: Aggregation Functions + description: Aggregation functions to apply to the scores of each row type: object + title: RegexParserScoringFnParams + description: Parameters for regex parser scoring function configuration. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: scoring_function - default: scoring_function - title: Type type: string + const: scoring_function + title: Type + default: scoring_function description: anyOf: - type: string - type: 'null' - nullable: true metadata: additionalProperties: true - description: Any additional metadata for this definition - title: Metadata type: object + title: Metadata + description: Any additional metadata for this definition 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 @@ -7701,32 +8525,45 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + description: The return type of the deterministic function + discriminator: + propertyName: type + 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' params: anyOf: - - discriminator: - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - propertyName: type - oneOf: + - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + type: object required: - identifier - provider_id - return_type title: ScoringFn - type: object + description: A scoring function resource for evaluating model outputs. ScoringFnParams: discriminator: mapping: @@ -7743,127 +8580,124 @@ components: title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams StringType: - description: Parameter type for string values. properties: type: + type: string const: string - default: string title: Type - type: string - title: StringType + default: string type: object + title: StringType + description: Parameter type for string values. UnionType: - description: Parameter type for union values. properties: type: - const: union - default: union - title: Type type: string - title: UnionType + const: union + title: Type + default: union type: object + title: UnionType + description: Parameter type for union values. ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' - title: Data type: array + title: Data + type: object required: - data title: ListScoringFunctionsResponse - type: object ScoreResponse: - description: The response from scoring. properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Results type: object + title: Results + type: object required: - results title: ScoreResponse - type: object + description: The response from scoring. ScoringResult: - description: A scoring result for a single row. properties: score_rows: items: additionalProperties: true type: object - title: Score Rows type: array + title: Score Rows aggregated_results: additionalProperties: true - title: Aggregated Results type: object + title: Aggregated Results + type: object required: - score_rows - aggregated_results title: ScoringResult - type: object + description: A scoring result for a single row. 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 + title: Results + type: object required: - results title: ScoreBatchResponse - type: object + description: Response from batch scoring operations on datasets. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: shield - default: shield - title: Type type: string + const: shield + title: Type + default: shield params: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true + type: object required: - identifier - provider_id title: Shield - type: object + description: A safety shield resource that can be used to check content. ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' - title: Data type: array + title: Data + type: object required: - data title: ListShieldsResponse - type: object ImageContentItem: description: A image content item properties: @@ -7920,184 +8754,172 @@ components: title: TextContentItem title: ImageContentItem | TextContentItem TextContentItem: - description: A text content item properties: type: + type: string const: text - default: text title: Type - type: string + default: text text: - title: Text type: string + title: Text + type: object required: - text title: TextContentItem - type: object + description: A text content item 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 + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Output | TextContentItem] - type: 'null' - title: string | list[ImageContentItem | TextContentItem] - nullable: true + title: string | list[ImageContentItem-Output | TextContentItem] 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 + title: ToolInvocationResult + description: Result of a tool invocation. URL: - description: A URL reference to external content. properties: uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URL - type: object + description: A URL reference to external content. ToolDef: - description: Tool definition used in runtime contexts. properties: toolgroup_id: anyOf: - type: string - type: 'null' - nullable: true name: - title: Name type: string + title: Name 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 + type: object required: - name title: ToolDef - type: object + description: Tool definition used in runtime contexts. ListToolDefsResponse: - description: Response containing a list of tool definitions. properties: data: items: $ref: '#/components/schemas/ToolDef' - title: Data type: array + title: Data + type: object required: - data title: ListToolDefsResponse - type: object + description: Response containing a list of tool definitions. ToolGroup: - description: A group of related tools managed together. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: tool_group - default: tool_group - title: Type type: string + const: tool_group + title: Type + default: tool_group 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 + type: object required: - identifier - provider_id title: ToolGroup - type: object + description: A group of related tools managed together. ListToolGroupsResponse: - description: Response containing a list of tool groups. properties: data: items: $ref: '#/components/schemas/ToolGroup' - title: Data type: array + title: Data + type: object required: - data title: ListToolGroupsResponse - type: object + description: Response containing a list of tool groups. Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -8157,105 +8979,94 @@ components: title: Chunk 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 + title: 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. QueryChunksResponse: - description: Response from querying chunks in a vector database. properties: chunks: items: - $ref: '#/components/schemas/Chunk' - title: Chunks + $ref: '#/components/schemas/Chunk-Output' type: array + title: Chunks scores: items: type: number - title: Scores type: array + title: Scores + type: object required: - chunks - scores title: QueryChunksResponse - type: object + description: Response from querying chunks in a vector database. VectorStoreFileCounts: - description: File processing status counts for a vector store. properties: completed: + type: integer title: Completed - type: integer cancelled: + type: integer title: Cancelled - type: integer failed: + type: integer title: Failed - type: integer in_progress: + type: integer title: In Progress - type: integer total: - title: Total type: integer + title: Total + type: object required: - completed - cancelled @@ -8263,91 +9074,85 @@ components: - in_progress - total title: VectorStoreFileCounts - type: object + description: File processing status counts for a vector store. VectorStoreListResponse: - description: Response from listing vector stores. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListResponse - type: object + description: Response from listing vector stores. VectorStoreObject: - description: OpenAI Vector Store object. properties: id: + type: string title: Id - type: string object: - default: vector_store - title: Object type: string + title: Object + default: vector_store created_at: - title: Created At type: integer + title: Created At name: anyOf: - type: string - type: 'null' - nullable: true usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: - default: completed - title: Status type: string + title: Status + default: completed 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 + title: Metadata + type: object required: - id - created_at - file_counts title: VectorStoreObject - type: object + description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: @@ -8361,159 +9166,151 @@ components: title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreChunkingStrategyAuto: - description: Automatic chunking strategy for vector store files. properties: type: + type: string const: auto - default: auto title: Type - type: string - title: VectorStoreChunkingStrategyAuto + default: auto type: object + title: VectorStoreChunkingStrategyAuto + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: - description: Static chunking strategy with configurable parameters. properties: type: - const: static - default: static - title: Type type: string + const: static + title: Type + default: static static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + type: object required: - static title: VectorStoreChunkingStrategyStatic - type: object + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: - description: Configuration for static chunking strategy. properties: chunk_overlap_tokens: - default: 400 + type: integer title: Chunk Overlap Tokens - type: integer + default: 400 max_chunk_size_tokens: - default: 800 - maximum: 4096 - minimum: 100 - title: Max Chunk Size Tokens type: integer - title: VectorStoreChunkingStrategyStaticConfig + maximum: 4096.0 + minimum: 100.0 + title: Max Chunk Size Tokens + default: 800 type: object + title: VectorStoreChunkingStrategyStaticConfig + description: Configuration for static chunking strategy. 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' - nullable: true - title: OpenAICreateVectorStoreRequestWithExtraBody + additionalProperties: true type: object + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. VectorStoreDeleteResponse: - description: Response from deleting a vector store. properties: id: + type: string title: Id - type: string object: - default: vector_store.deleted - title: Object type: string + title: Object + default: vector_store.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreDeleteResponse - type: object + description: Response from deleting a vector store. 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 + title: File Ids 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: + - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy - nullable: true + additionalProperties: true + type: object required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - type: object + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: - description: OpenAI Vector Store File Batch object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file_batch + type: string title: Object - type: string + default: vector_store.file_batch created_at: - title: Created At type: integer + title: Created At vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id status: title: Status type: string @@ -8525,6 +9322,7 @@ components: default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' + type: object required: - id - created_at @@ -8532,7 +9330,7 @@ components: - status - file_counts title: VectorStoreFileBatchObject - type: object + description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: type: string enum: @@ -8542,7 +9340,6 @@ components: - failed default: completed VectorStoreFileLastError: - description: Error information for failed vector store file processing. properties: code: title: Code @@ -8552,48 +9349,47 @@ components: - rate_limit_exceeded default: server_error message: - title: Message type: string + title: Message + type: object required: - code - message title: VectorStoreFileLastError - type: object + description: Error information for failed vector store file processing. VectorStoreFileObject: - description: OpenAI Vector Store File object. properties: id: + type: string title: Id - type: string object: - default: vector_store.file - title: Object type: string + title: Object + default: vector_store.file attributes: additionalProperties: true - title: Attributes type: object + title: Attributes 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 + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' created_at: - title: Created At type: integer + title: Created At last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' - nullable: true title: VectorStoreFileLastError status: title: Status @@ -8605,12 +9401,13 @@ components: - failed default: completed usage_bytes: - default: 0 - title: Usage Bytes type: integer + title: Usage Bytes + default: 0 vector_store_id: - title: Vector Store Id type: string + title: Vector Store Id + type: object required: - id - chunking_strategy @@ -8618,158 +9415,149 @@ components: - status - vector_store_id title: VectorStoreFileObject - type: object + description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: - description: Response from listing files in a vector store file batch. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreFilesListInBatchResponse - type: object + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: - description: Response from listing files in a vector store. properties: object: - default: list - title: Object type: string + title: Object + default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' - title: Data type: array + title: Data 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 + title: Has More + default: false + type: object required: - data title: VectorStoreListFilesResponse - type: object + description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: - description: Response from deleting a vector store file. properties: id: + type: string title: Id - type: string object: - default: vector_store.file.deleted - title: Object type: string + title: Object + default: vector_store.file.deleted deleted: - default: true - title: Deleted type: boolean + title: Deleted + default: true + type: object required: - id title: VectorStoreFileDeleteResponse - type: object + description: Response from deleting a vector store file. VectorStoreContent: - description: Content item from a vector store file or search result. properties: type: + type: string const: text title: Type - type: string text: - title: Text type: string + title: Text 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 + type: object required: - type - text title: VectorStoreContent - type: object + description: Content item from a vector store file or search result. 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 + const: vector_store.file_content.page + title: Object + default: vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data title: VectorStoreFileContentResponse - type: object + description: Represents the parsed content of a vector store file. VectorStoreSearchResponse: - description: Response from searching a vector store. properties: file_id: + type: string title: File Id - type: string filename: - title: Filename type: string + title: Filename score: - title: Score type: number + title: Score attributes: anyOf: - additionalProperties: @@ -8780,241 +9568,230 @@ components: title: string | number | boolean type: object - type: 'null' - nullable: true content: items: $ref: '#/components/schemas/VectorStoreContent' - title: Content type: array + title: Content + type: object required: - file_id - filename - score - content title: VectorStoreSearchResponse - type: object + description: Response from searching a vector store. VectorStoreSearchResponsePage: - description: Paginated response from searching a vector store. properties: object: - default: vector_store.search_results.page - title: Object type: string + title: Object + default: vector_store.search_results.page search_query: items: type: string - title: Search Query type: array + title: Search Query data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' - title: Data type: array + title: Data has_more: - default: false - title: Has More type: boolean + title: Has More + default: false next_page: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - search_query - data title: VectorStoreSearchResponsePage - type: object + description: Paginated response from searching a vector store. VersionInfo: - description: Version information for the service. properties: version: - title: Version type: string + title: Version + type: object required: - version title: VersionInfo - type: object + description: Version information for the service. PaginatedResponse: - description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object - title: Data type: array + title: Data has_more: - title: Has More type: boolean + title: Has More url: anyOf: - type: string - type: 'null' - nullable: true + type: object required: - data - has_more title: PaginatedResponse - type: object + description: A generic paginated response that follows a simple format. 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 + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: - const: dataset - default: dataset - title: Type type: string + const: dataset + title: Type + default: dataset 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 + discriminator: + propertyName: type + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' metadata: additionalProperties: true - description: Any additional metadata for this dataset - title: Metadata type: object + title: Metadata + description: Any additional metadata for this dataset + type: object required: - identifier - provider_id - purpose - source title: Dataset - type: object + description: Dataset resource for storing and accessing training or evaluation data. RowsDataSource: - description: A dataset stored in rows. properties: type: - const: rows - default: rows - title: Type type: string + const: rows + title: Type + default: rows rows: items: additionalProperties: true type: object - title: Rows type: array + title: Rows + type: object required: - rows title: RowsDataSource - type: object + description: A dataset stored in rows. URIDataSource: - description: A dataset that can be obtained from a URI. properties: type: + type: string const: uri - default: uri title: Type - type: string + default: uri uri: - title: Uri type: string + title: Uri + type: object required: - uri title: URIDataSource - type: object + description: A dataset that can be obtained from a URI. ListDatasetsResponse: - description: Response from listing datasets. properties: data: items: $ref: '#/components/schemas/Dataset' - title: Data type: array + title: Data + type: object required: - data title: ListDatasetsResponse - type: object + description: Response from listing datasets. Benchmark: - description: A benchmark resource for evaluating model performance. properties: identifier: - description: Unique identifier for this resource in llama stack - title: Identifier type: string + title: Identifier + description: Unique identifier for this resource in llama stack 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 + type: string title: Provider Id - type: string + description: ID of the provider that owns this resource type: + type: string const: benchmark - default: benchmark title: Type - type: string + default: benchmark dataset_id: - title: Dataset Id type: string + title: Dataset Id scoring_functions: items: type: string - title: Scoring Functions type: array + title: Scoring Functions metadata: additionalProperties: true - description: Metadata for this evaluation task - title: Metadata type: object + title: Metadata + description: Metadata for this evaluation task + type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark - type: object + description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' - title: Data type: array + title: Data + type: object required: - data title: ListBenchmarksResponse - 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 @@ -9022,41 +9799,46 @@ components: title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' 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 + title: Scoring Params + description: Map between scoring function id and parameters for each scoring function you want to run 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 + type: object required: - eval_candidate title: BenchmarkConfig - type: object + description: A benchmark configuration for evaluation. GreedySamplingStrategy: - description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: + type: string const: greedy - default: greedy title: Type - type: string - title: GreedySamplingStrategy + default: greedy type: object + title: GreedySamplingStrategy + description: Greedy sampling strategy that selects the highest probability token at each step. ModelCandidate: - description: A model candidate for evaluation. properties: type: + type: string const: model - default: model title: Type - type: string + default: model model: - title: Model type: string + title: Model sampling_params: $ref: '#/components/schemas/SamplingParams' system_message: @@ -9064,23 +9846,16 @@ components: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' - nullable: true title: SystemMessage + type: object required: - model - sampling_params title: ModelCandidate - type: object + description: A model candidate for evaluation. 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 @@ -9089,11 +9864,16 @@ components: - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + discriminator: + propertyName: type + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' max_tokens: anyOf: - type: integer - type: 'null' - nullable: true repetition_penalty: anyOf: - type: number @@ -9105,74 +9885,73 @@ components: type: string type: array - type: 'null' - nullable: true - title: SamplingParams type: object + title: SamplingParams + description: Sampling parameters. SystemMessage: - description: A system message providing instructions or context to the model. properties: role: - const: system - default: system - title: Role type: string + const: system + title: Role + default: system content: anyOf: - type: string - - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type - oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem - items: - discriminator: - mapping: - image: '#/components/schemas/ImageContentItem' - text: '#/components/schemas/TextContentItem' - propertyName: type oneOf: - - $ref: '#/components/schemas/ImageContentItem' - title: ImageContentItem + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem - title: ImageContentItem | TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem type: array - title: list[ImageContentItem | TextContentItem] - title: string | list[ImageContentItem | TextContentItem] + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + type: object required: - content title: SystemMessage - type: object + description: A system message providing instructions or context to the model. 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 + const: top_k + title: Type + default: top_k top_k: - minimum: 1 - title: Top K type: integer + minimum: 1.0 + title: Top K + type: object required: - top_k title: TopKSamplingStrategy - type: object + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. 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 + const: top_p + title: Type + default: top_p temperature: anyOf: - type: number @@ -9183,94 +9962,94 @@ components: - type: number - type: 'null' default: 0.95 + type: object required: - temperature title: TopPSamplingStrategy - type: object + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. EvaluateResponse: - description: The response from an evaluation. properties: generations: items: additionalProperties: true type: object - title: Generations type: array + title: Generations scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' - title: Scores type: object + title: Scores + type: object required: - generations - scores title: EvaluateResponse - type: object + description: The response from an evaluation. Job: - description: A job execution instance with status tracking. properties: job_id: - title: Job Id type: string + title: Job Id status: $ref: '#/components/schemas/JobStatus' + type: object required: - job_id - status title: Job - type: object + description: A job execution instance with status tracking. RerankData: - description: A single rerank result from a reranking response. properties: index: - title: Index type: integer + title: Index relevance_score: - title: Relevance Score type: number + title: Relevance Score + type: object required: - index - relevance_score title: RerankData - type: object + description: A single rerank result from a reranking response. RerankResponse: - description: Response from a reranking request. properties: data: items: $ref: '#/components/schemas/RerankData' - title: Data type: array + title: Data + type: object required: - data title: RerankResponse - type: object + description: Response from a reranking request. Checkpoint: - description: Checkpoint created during training runs. properties: identifier: - title: Identifier type: string + title: Identifier created_at: + type: string format: date-time title: Created At - type: string epoch: - title: Epoch type: integer + title: Epoch post_training_job_id: + type: string title: Post Training Job Id - type: string path: - title: Path type: string + title: Path training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' - nullable: true title: PostTrainingMetric + type: object required: - identifier - created_at @@ -9278,137 +10057,131 @@ components: - post_training_job_id - path title: Checkpoint - type: object + description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: - description: Artifacts of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid checkpoints: items: $ref: '#/components/schemas/Checkpoint' - title: Checkpoints type: array + title: Checkpoints + type: object required: - job_uuid title: PostTrainingJobArtifactsResponse - type: object + description: Artifacts of a finetuning job. PostTrainingMetric: - description: Training metrics captured during post-training jobs. properties: epoch: - title: Epoch type: integer + title: Epoch train_loss: + type: number title: Train Loss - type: number validation_loss: + type: number title: Validation Loss - type: number perplexity: - title: Perplexity type: number + title: Perplexity + type: object required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric - type: object + description: Training metrics captured during post-training jobs. PostTrainingJobStatusResponse: - description: Status of a finetuning job. properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true started_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - type: 'null' - nullable: true completed_at: anyOf: - - format: date-time - type: string + - type: string + format: date-time - 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 + title: Checkpoints + type: object required: - job_uuid - status title: PostTrainingJobStatusResponse - type: object + description: Status of a finetuning job. ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' - title: Data type: array + title: Data + type: object required: - data title: ListPostTrainingJobsResponse - type: object DPOAlignmentConfig: - description: Configuration for Direct Preference Optimization (DPO) alignment. properties: beta: - title: Beta type: number + title: Beta loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid + type: object required: - beta title: DPOAlignmentConfig - type: object + description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: + type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType - type: string DataConfig: - description: Configuration for training data and data loading. properties: dataset_id: - title: Dataset Id type: string + title: Dataset Id batch_size: - title: Batch Size type: integer + title: Batch Size shuffle: - title: Shuffle type: boolean + title: Shuffle data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' - nullable: true packed: anyOf: - type: boolean @@ -9419,22 +10192,22 @@ components: - type: boolean - type: 'null' default: false + type: object required: - dataset_id - batch_size - shuffle - data_format title: DataConfig - type: object + description: Configuration for training data and data loading. DatasetFormat: - description: Format of the training dataset. + type: string enum: - instruct - dialog title: DatasetFormat - type: string + description: Format of the training dataset. EfficiencyConfig: - description: Configuration for memory and compute efficiency optimizations. properties: enable_activation_checkpointing: anyOf: @@ -9456,51 +10229,51 @@ components: - type: boolean - type: 'null' default: false - title: EfficiencyConfig type: object + title: EfficiencyConfig + description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: - description: Configuration parameters for the optimization algorithm. properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: + type: number title: Lr - type: number weight_decay: - title: Weight Decay type: number + title: Weight Decay num_warmup_steps: - title: Num Warmup Steps type: integer + title: Num Warmup Steps + type: object required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig - type: object + description: Configuration parameters for the optimization algorithm. OptimizerType: - description: Available optimizer algorithms for training. + type: string enum: - adam - adamw - sgd title: OptimizerType - type: string + description: Available optimizer algorithms for training. TrainingConfig: - description: Comprehensive configuration for the training process. properties: n_epochs: + type: integer title: N Epochs - type: integer max_steps_per_epoch: - default: 1 + type: integer title: Max Steps Per Epoch - type: integer - gradient_accumulation_steps: default: 1 - title: Gradient Accumulation Steps + gradient_accumulation_steps: type: integer + title: Gradient Accumulation Steps + default: 1 max_validation_steps: anyOf: - type: integer @@ -9511,40 +10284,38 @@ components: - $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 + type: object required: - n_epochs title: TrainingConfig - type: object + description: Comprehensive configuration for the training process. PostTrainingJob: properties: job_uuid: - title: Job Uuid type: string + title: Job Uuid + type: object required: - job_uuid title: PostTrainingJob - type: object AlgorithmConfig: discriminator: mapping: @@ -9558,30 +10329,29 @@ components: title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig LoraFinetuningConfig: - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. properties: type: - const: LoRA - default: LoRA - title: Type type: string + const: LoRA + title: Type + default: LoRA lora_attn_modules: items: type: string - title: Lora Attn Modules type: array + title: Lora Attn Modules apply_lora_to_mlp: + type: boolean title: Apply Lora To Mlp - type: boolean apply_lora_to_output: - title: Apply Lora To Output type: boolean + title: Apply Lora To Output rank: + type: integer title: Rank - type: integer alpha: - title: Alpha type: integer + title: Alpha use_dora: anyOf: - type: boolean @@ -9592,6 +10362,7 @@ components: - type: boolean - type: 'null' default: false + type: object required: - lora_attn_modules - apply_lora_to_mlp @@ -9599,26 +10370,26 @@ components: - rank - alpha title: LoraFinetuningConfig - type: object + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. properties: type: + type: string const: QAT - default: QAT title: Type - type: string + default: QAT quantizer_name: - title: Quantizer Name type: string + title: Quantizer Name group_size: - title: Group Size type: integer + title: Group Size + type: object required: - quantizer_name - group_size title: QATFinetuningConfig - type: object + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. ParamType: discriminator: mapping: @@ -9664,24 +10435,1600 @@ components: - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource + AllowedToolsFilter: + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can be used. + ApprovalFilter: + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. + BatchError: + properties: + code: + anyOf: + - type: string + - type: 'null' + line: + anyOf: + - type: integer + - type: 'null' + message: + anyOf: + - type: string + - type: 'null' + param: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: BatchError + BatchRequestCounts: + properties: + completed: + type: integer + title: Completed + failed: + type: integer + title: Failed + total: + type: integer + title: Total + additionalProperties: true + type: object + required: + - completed + - failed + - total + title: BatchRequestCounts + BatchUsage: + properties: + input_tokens: + type: integer + title: Input Tokens + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + type: integer + title: Output Tokens + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + type: integer + title: Total Tokens + additionalProperties: true + type: object + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + BatchesPostRequest: + properties: + input_file_id: + type: string + title: Input File Id + endpoint: + type: string + title: Endpoint + completion_window: + type: string + const: 24h + title: Completion Window + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + idempotency_key: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_file_id + - endpoint + - completion_window + title: BatchesPostRequest + Body_openai_upload_file_v1_files_post: + properties: + file: + type: string + format: binary + title: File + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + expires_after: + anyOf: + - $ref: '#/components/schemas/ExpiresAfter' + title: ExpiresAfter + - type: 'null' + title: ExpiresAfter + type: object + required: + - file + - purpose + title: Body_openai_upload_file_v1_files_post + Body_register_benchmark_v1alpha_eval_benchmarks_post: + properties: + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - scoring_functions + title: Body_register_benchmark_v1alpha_eval_benchmarks_post + Body_register_scoring_function_v1_scoring_functions_post: + properties: + return_type: + anyOf: + - $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: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: Params + type: object + required: + - return_type + title: Body_register_scoring_function_v1_scoring_functions_post + Body_register_tool_group_v1_toolgroups_post: + properties: + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: Body_register_tool_group_v1_toolgroups_post + Chunk-Input: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + Chunk-Output: + properties: + content: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Output' + title: ImageContentItem-Output + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Output' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Output | TextContentItem + type: array + title: list[ImageContentItem-Output | TextContentItem] + title: string | list[ImageContentItem-Output | TextContentItem] + chunk_id: + type: string + title: Chunk Id + metadata: + additionalProperties: true + type: object + title: Metadata + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + title: ChunkMetadata + type: object + required: + - content + - chunk_id + title: Chunk + description: A chunk of content that can be inserted into a vector database. + ConversationItemInclude: + type: string + enum: + - web_search_call.action.sources + - code_interpreter_call.outputs + - computer_call_output.output.image_url + - file_search_call.results + - message.input_image.image_url + - message.output_text.logprobs + - reasoning.encrypted_content + title: ConversationItemInclude + description: Specify additional output data to include in the model response. + ConversationsByConversationIdItemsPostRequest: + properties: + items: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + title: Items + type: object + required: + - items + title: ConversationsByConversationIdItemsPostRequest + ConversationsByConversationIdPostRequest: + properties: + metadata: + additionalProperties: + type: string + type: object + title: Metadata + type: object + required: + - metadata + title: ConversationsByConversationIdPostRequest + ConversationsPostRequest: + properties: + items: + anyOf: + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (9 variants) + type: array + - type: 'null' + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + type: object + title: ConversationsPostRequest + DatasetPurpose: + type: string + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + description: Purpose of the dataset. Each purpose has a required input data schema. + Errors: + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + object: + anyOf: + - type: string + - type: 'null' + additionalProperties: true + type: object + title: Errors + HealthStatus: + type: string + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + ImageContentItem-Input: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + ImageContentItem-Output: + properties: + type: + type: string + const: image + title: Type + default: image + image: + $ref: '#/components/schemas/_URLOrData' + type: object + required: + - image + title: ImageContentItem + description: A image content item + InputTokensDetails: + properties: + cached_tokens: + type: integer + title: Cached Tokens + additionalProperties: true + type: object + required: + - cached_tokens + title: InputTokensDetails + JobStatus: + type: string + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + description: Status of a job execution. + MCPListToolsTool: + properties: + input_schema: + additionalProperties: true + type: object + title: Input Schema + name: + type: string + title: Name + description: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input_schema + - name + title: MCPListToolsTool + description: Tool definition returned by MCP list tools operation. + ModelsPostRequest: + properties: + model_id: + type: string + title: Model Id + provider_model_id: + anyOf: + - type: string + - type: 'null' + provider_id: + anyOf: + - type: string + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + model_type: + anyOf: + - $ref: '#/components/schemas/ModelType' + title: ModelType + - type: 'null' + title: ModelType + type: object + required: + - model_id + title: ModelsPostRequest + ModerationsPostRequest: + properties: + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + model: + anyOf: + - type: string + - type: 'null' + type: object + required: + - input + title: ModerationsPostRequest + OpenAIAssistantMessageParam-Input: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIAssistantMessageParam-Output: + properties: + role: + type: string + const: assistant + title: Role + default: assistant + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + - type: 'null' + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + tool_calls: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIChatCompletionToolCall' + type: array + - type: 'null' + type: object + title: OpenAIAssistantMessageParam + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. + OpenAIChatCompletionUsageCompletionTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. + OpenAIChatCompletionUsagePromptTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. + OpenAIResponseMessage-Input: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseMessage-Output: + properties: + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + discriminator: + propertyName: type + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: array + title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + title: OpenAIResponseOutputMessageContentOutputText + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + title: OpenAIResponseContentPartRefusal + discriminator: + propertyName: type + mapping: + output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + refusal: '#/components/schemas/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: + type: string + const: message + title: Type + default: message + id: + anyOf: + - type: string + - type: 'null' + status: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + - role + title: 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. + OpenAIResponseOutputMessageFileSearchToolCallResults: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + file_id: + type: string + title: File Id + filename: + type: string + title: Filename + score: + type: number + title: Score + text: + type: string + title: Text + type: object + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + OpenAIResponseTextFormat: + 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' + type: object + title: OpenAIResponseTextFormat + description: Configuration for Responses API text format. + OpenAIResponseUsageInputTokensDetails: + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageInputTokensDetails + description: Token details for input tokens in OpenAI response usage. + OpenAIResponseUsageOutputTokensDetails: + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + type: object + title: OpenAIResponseUsageOutputTokensDetails + description: Token details for output tokens in OpenAI response usage. + OpenAIUserMessageParam-Input: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OpenAIUserMessageParam-Output: + properties: + role: + type: string + const: user + title: Role + default: user + content: + anyOf: + - type: string + - items: + oneOf: + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + - $ref: '#/components/schemas/OpenAIFile' + title: OpenAIFile + discriminator: + propertyName: type + mapping: + file: '#/components/schemas/OpenAIFile' + image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile + type: array + title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] + name: + anyOf: + - type: string + - type: 'null' + type: object + required: + - content + title: OpenAIUserMessageParam + description: A message from the user in an OpenAI-compatible chat completion request. + OutputTokensDetails: + properties: + reasoning_tokens: + type: integer + title: Reasoning Tokens + additionalProperties: true + type: object + required: + - reasoning_tokens + title: OutputTokensDetails + PromptsByPromptIdPostRequest: + properties: + prompt: + type: string + title: Prompt + version: + type: integer + title: Version + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + set_as_default: + type: boolean + title: Set As Default + default: true + type: object + required: + - prompt + - version + title: PromptsByPromptIdPostRequest + PromptsByPromptIdSetDefaultVersionPostRequest: + properties: + version: + type: integer + title: Version + type: object + required: + - version + title: PromptsByPromptIdSetDefaultVersionPostRequest + PromptsPostRequest: + properties: + prompt: + type: string + title: Prompt + variables: + anyOf: + - items: + type: string + type: array + - type: 'null' + type: object + required: + - prompt + title: PromptsPostRequest + ResponsesPostRequest: + properties: + input: + anyOf: + - type: string + - items: + anyOf: + - oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + - $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 + discriminator: + propertyName: type + 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-Input' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseMessage-Input | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage-Input' + title: OpenAIResponseMessage-Input + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input + type: array + title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] + model: + type: string + title: Model + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + title: OpenAIResponsePrompt + instructions: + anyOf: + - type: string + - type: 'null' + previous_response_id: + anyOf: + - type: string + - type: 'null' + conversation: + anyOf: + - type: string + - type: 'null' + store: + anyOf: + - type: boolean + - type: 'null' + default: true + stream: + anyOf: + - type: boolean + - type: 'null' + default: false + temperature: + anyOf: + - type: number + - type: 'null' + text: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseText' + title: OpenAIResponseText + - type: 'null' + title: OpenAIResponseText + tools: + anyOf: + - items: + 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 + discriminator: + propertyName: type + 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' + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + include: + anyOf: + - items: + type: string + type: array + - type: 'null' + max_infer_iters: + anyOf: + - type: integer + - type: 'null' + default: 10 + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - input + - model + title: ResponsesPostRequest + SafetyRunShieldPostRequest: + properties: + shield_id: + type: string + title: Shield Id + messages: + items: + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' + title: OpenAIAssistantMessageParam-Input + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + discriminator: + propertyName: role + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam-Input' + title: OpenAIUserMessageParam-Input | ... (5 variants) + type: array + title: Messages + params: + additionalProperties: true + type: object + title: Params + type: object + required: + - shield_id + - messages + - params + title: SafetyRunShieldPostRequest + ScoringScoreBatchPostRequest: + properties: + dataset_id: + type: string + title: Dataset Id + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + save_results_dataset: + type: boolean + title: Save Results Dataset + default: false + type: object + required: + - dataset_id + - scoring_functions + title: ScoringScoreBatchPostRequest + ScoringScorePostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + additionalProperties: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + discriminator: + propertyName: type + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + title: AdditionalpropertiesUnion + type: object + title: Scoring Functions + type: object + required: + - input_rows + - scoring_functions + title: ScoringScorePostRequest + SearchRankingOptions: + properties: + ranker: + anyOf: + - type: string + - type: 'null' + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + type: object + title: SearchRankingOptions + description: Options for ranking and filtering search results. + ShieldsPostRequest: + properties: + shield_id: + type: string + title: Shield Id + provider_shield_id: + anyOf: + - type: string + - type: 'null' + provider_id: + anyOf: + - type: string + - type: 'null' + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - shield_id + title: ShieldsPostRequest + ToolRuntimeInvokePostRequest: + properties: + tool_name: + type: string + title: Tool Name + kwargs: + additionalProperties: true + type: object + title: Kwargs + authorization: + anyOf: + - type: string + - type: 'null' + type: object + required: + - tool_name + - kwargs + title: ToolRuntimeInvokePostRequest + V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest: + properties: + input_rows: + items: + additionalProperties: true + type: object + type: array + title: Input Rows + scoring_functions: + items: + type: string + type: array + title: Scoring Functions + benchmark_config: + $ref: '#/components/schemas/BenchmarkConfig' + type: object + required: + - input_rows + - scoring_functions + - benchmark_config + title: V1AlphaEvalBenchmarksByBenchmarkIdEvaluationsPostRequest + V1AlphaInferenceRerankPostRequest: + properties: + model: + type: string + title: Model + query: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + items: + items: + anyOf: + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + title: OpenAIChatCompletionContentPartTextParam + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + title: OpenAIChatCompletionContentPartImageParam + title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam + type: array + title: Items + max_num_results: + anyOf: + - type: integer + - type: 'null' + type: object + required: + - model + - query + - items + title: V1AlphaInferenceRerankPostRequest + V1AlphaPostTrainingPreferenceOptimizePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + finetuned_model: + type: string + title: Finetuned Model + algorithm_config: + $ref: '#/components/schemas/DPOAlignmentConfig' + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + type: object + required: + - job_uuid + - finetuned_model + - algorithm_config + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingPreferenceOptimizePostRequest + V1AlphaPostTrainingSupervisedFineTunePostRequest: + properties: + job_uuid: + type: string + title: Job Uuid + training_config: + $ref: '#/components/schemas/TrainingConfig' + hyperparam_search_config: + additionalProperties: true + type: object + title: Hyperparam Search Config + logger_config: + additionalProperties: true + type: object + title: Logger Config + model: + anyOf: + - type: string + - type: 'null' + description: Model descriptor for training if not in provider config` + checkpoint_dir: + anyOf: + - type: string + - type: 'null' + algorithm_config: + anyOf: + - oneOf: + - $ref: '#/components/schemas/LoraFinetuningConfig' + title: LoraFinetuningConfig + - $ref: '#/components/schemas/QATFinetuningConfig' + title: QATFinetuningConfig + discriminator: + propertyName: type + mapping: + LoRA: '#/components/schemas/LoraFinetuningConfig' + QAT: '#/components/schemas/QATFinetuningConfig' + title: LoraFinetuningConfig | QATFinetuningConfig + - type: 'null' + title: Algorithm Config + type: object + required: + - job_uuid + - training_config + - hyperparam_search_config + - logger_config + title: V1AlphaPostTrainingSupervisedFineTunePostRequest + V1BetaDatasetsPostRequestLoose: + properties: + purpose: + title: Purpose + source: + title: Source + metadata: + title: Metadata + dataset_id: + title: Dataset Id + type: object + required: + - purpose + - source + title: V1BetaDatasetsPostRequestLoose + VectorIoQueryPostRequest: + properties: + vector_store_id: + type: string + title: Vector Store Id + query: + anyOf: + - type: string + - oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + - items: + oneOf: + - $ref: '#/components/schemas/ImageContentItem-Input' + title: ImageContentItem-Input + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + discriminator: + propertyName: type + mapping: + image: '#/components/schemas/ImageContentItem-Input' + text: '#/components/schemas/TextContentItem' + title: ImageContentItem-Input | TextContentItem + type: array + title: list[ImageContentItem-Input | TextContentItem] + title: string | list[ImageContentItem-Input | TextContentItem] + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + required: + - vector_store_id + - query + title: VectorIoQueryPostRequest + VectorStoresByVectorStoreIdFilesByFileIdPostRequest: + properties: + attributes: + additionalProperties: true + type: object + title: Attributes + type: object + required: + - attributes + title: VectorStoresByVectorStoreIdFilesByFileIdPostRequest + VectorStoresByVectorStoreIdFilesPostRequest: + properties: + file_id: + type: string + title: File Id + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + chunking_strategy: + anyOf: + - oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + discriminator: + propertyName: type + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + type: object + required: + - file_id + title: VectorStoresByVectorStoreIdFilesPostRequest + VectorStoresByVectorStoreIdPostRequest: + properties: + name: + anyOf: + - type: string + - type: 'null' + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + type: object + title: VectorStoresByVectorStoreIdPostRequest + VectorStoresByVectorStoreIdSearchPostRequest: + 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' + max_num_results: + anyOf: + - type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + title: SearchRankingOptions + rewrite_query: + anyOf: + - type: boolean + - type: 'null' + default: false + search_mode: + anyOf: + - type: string + - type: 'null' + default: vector + type: object + required: + - query + title: VectorStoresByVectorStoreIdSearchPostRequest _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 + title: _URLOrData + description: A URL or a base64 encoded string SamplingStrategy: discriminator: mapping: @@ -9741,99 +12088,6 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat - 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 - 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 - 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 - 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 OpenAIResponseContentPart: discriminator: mapping: @@ -9849,56 +12103,6 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText - 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 - 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 SpanEndPayload: description: Payload for a span end event. properties: @@ -10120,110 +12324,6 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - 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 ImageDelta: description: An image content delta for streaming responses. properties: @@ -10255,16 +12355,6 @@ components: - text title: TextDelta type: object - JobStatus: - description: Status of a job execution. - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - type: string MetricInResponse: description: A metric value included in API responses. properties: @@ -10380,14 +12470,6 @@ components: - 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 Api: description: Enumeration of all available APIs in the Llama Stack system. enum: @@ -10716,26 +12798,6 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig 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 OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -10906,13 +12968,6 @@ components: - content title: UserMessage type: object - HealthStatus: - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - type: string PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -11093,3 +13148,131 @@ components: - query title: VectorStoreSearchRequest type: object + 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' +tags: +- description: APIs for creating and interacting with agentic systems. + name: Agents + x-displayName: Agents +- description: |- + The API is designed to allow use of openai client libraries for seamless integration. + + This API provides the following extensions: + - idempotent batch creation + + Note: This API is currently under active development and may undergo changes. + name: Batches + x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale. +- description: '' + name: Benchmarks +- description: Protocol for conversation management operations. + name: Conversations + x-displayName: Conversations +- description: '' + name: DatasetIO +- description: '' + name: Datasets +- description: Llama Stack Evaluation API for running evaluations on model and agent candidates. + name: Eval + x-displayName: Evaluations +- description: This API is used to upload documents that can be used with other Llama Stack APIs. + name: Files + x-displayName: Files +- description: |- + Llama Stack Inference API for generating completions, chat completions, and embeddings. + + This API provides the raw interface to the underlying models. Three kinds of models are supported: + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. + - Rerank models: these models reorder the documents based on their relevance to a query. + name: Inference + x-displayName: Inference +- description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers. + name: Inspect + x-displayName: Inspect +- description: '' + name: Models +- description: '' + name: PostTraining (Coming Soon) +- description: Protocol for prompt management operations. + name: Prompts + x-displayName: Prompts +- description: Providers API for inspecting, listing, and modifying providers and their configurations. + name: Providers + x-displayName: Providers +- description: OpenAI-compatible Moderations API. + name: Safety + x-displayName: Safety +- description: '' + name: Scoring +- description: '' + name: ScoringFunctions +- description: '' + name: Shields +- description: '' + name: ToolGroups +- description: '' + name: ToolRuntime +- description: '' + name: VectorIO +x-tagGroups: +- name: Operations + tags: + - Agents + - Batches + - Benchmarks + - Conversations + - DatasetIO + - Datasets + - Eval + - Files + - Inference + - Inspect + - Models + - PostTraining (Coming Soon) + - Prompts + - Providers + - Safety + - Scoring + - ScoringFunctions + - Shields + - ToolGroups + - ToolRuntime + - VectorIO +security: +- Default: [] diff --git a/scripts/openapi_generator/_legacy_order.py b/scripts/openapi_generator/_legacy_order.py index 254243d81..be0c379fd 100644 --- a/scripts/openapi_generator/_legacy_order.py +++ b/scripts/openapi_generator/_legacy_order.py @@ -12,7 +12,6 @@ These lists help the new generator match the previous ordering so that diffs remain readable while we debug schema content regressions. Remove once stable. """ -# TODO: remove once generator output stabilizes LEGACY_PATH_ORDER = ['/v1/batches', '/v1/batches/{batch_id}', '/v1/batches/{batch_id}/cancel', @@ -364,6 +363,57 @@ LEGACY_SCHEMA_ORDER = ['Error', LEGACY_RESPONSE_ORDER = ['BadRequest400', 'TooManyRequests429', 'InternalServerError500', 'DefaultError'] +LEGACY_TAGS = [{'description': 'APIs for creating and interacting with agentic systems.', + 'name': 'Agents', + 'x-displayName': 'Agents'}, + {'description': 'The API is designed to allow use of openai client libraries for seamless integration.\n' + '\n' + 'This API provides the following extensions:\n' + ' - idempotent batch creation\n' + '\n' + 'Note: This API is currently under active development and may undergo changes.', + 'name': 'Batches', + 'x-displayName': 'The Batches API enables efficient processing of multiple requests in a single operation, ' + 'particularly useful for processing large datasets, batch evaluation workflows, and cost-effective ' + 'inference at scale.'}, + {'description': '', 'name': 'Benchmarks'}, + {'description': 'Protocol for conversation management operations.', + 'name': 'Conversations', + 'x-displayName': 'Conversations'}, + {'description': '', 'name': 'DatasetIO'}, + {'description': '', 'name': 'Datasets'}, + {'description': 'Llama Stack Evaluation API for running evaluations on model and agent candidates.', + 'name': 'Eval', + 'x-displayName': 'Evaluations'}, + {'description': 'This API is used to upload documents that can be used with other Llama Stack APIs.', + 'name': 'Files', + 'x-displayName': 'Files'}, + {'description': 'Llama Stack Inference API for generating completions, chat completions, and embeddings.\n' + '\n' + 'This API provides the raw interface to the underlying models. Three kinds of models are supported:\n' + '- LLM models: these models generate "raw" and "chat" (conversational) completions.\n' + '- Embedding models: these models generate embeddings to be used for semantic search.\n' + '- Rerank models: these models reorder the documents based on their relevance to a query.', + 'name': 'Inference', + 'x-displayName': 'Inference'}, + {'description': 'APIs for inspecting the Llama Stack service, including health status, available API routes with ' + 'methods and implementing providers.', + 'name': 'Inspect', + 'x-displayName': 'Inspect'}, + {'description': '', 'name': 'Models'}, + {'description': '', 'name': 'PostTraining (Coming Soon)'}, + {'description': 'Protocol for prompt management operations.', 'name': 'Prompts', 'x-displayName': 'Prompts'}, + {'description': 'Providers API for inspecting, listing, and modifying providers and their configurations.', + 'name': 'Providers', + 'x-displayName': 'Providers'}, + {'description': 'OpenAI-compatible Moderations API.', 'name': 'Safety', 'x-displayName': 'Safety'}, + {'description': '', 'name': 'Scoring'}, + {'description': '', 'name': 'ScoringFunctions'}, + {'description': '', 'name': 'Shields'}, + {'description': '', 'name': 'ToolGroups'}, + {'description': '', 'name': 'ToolRuntime'}, + {'description': '', 'name': 'VectorIO'}] + LEGACY_TAG_ORDER = ['Agents', 'Batches', 'Benchmarks', @@ -408,3 +458,16 @@ LEGACY_TAG_GROUPS = [{'name': 'Operations', 'ToolGroups', 'ToolRuntime', 'VectorIO']}] + +LEGACY_SECURITY = [{'Default': []}] + +LEGACY_OPERATION_KEYS = [ + 'responses', + 'tags', + 'summary', + 'description', + 'operationId', + 'parameters', + 'requestBody', + 'deprecated', +] diff --git a/scripts/openapi_generator/app.py b/scripts/openapi_generator/app.py index bf7f4d70f..d972889cd 100644 --- a/scripts/openapi_generator/app.py +++ b/scripts/openapi_generator/app.py @@ -36,7 +36,7 @@ def _get_protocol_method(api: Api, method_name: str) -> Any | None: if _protocol_methods_cache is None: _protocol_methods_cache = {} protocols = api_protocol_map() - from llama_stack.apis.tools import SpecialToolGroup, ToolRuntime + from llama_stack_api.tools import SpecialToolGroup, ToolRuntime toolgroup_protocols = { SpecialToolGroup.rag_tool: ToolRuntime, diff --git a/scripts/openapi_generator/endpoints.py b/scripts/openapi_generator/endpoints.py index f3bf1382e..5e5152049 100644 --- a/scripts/openapi_generator/endpoints.py +++ b/scripts/openapi_generator/endpoints.py @@ -12,16 +12,45 @@ import inspect import re import types import typing -import uuid from typing import Annotated, Any, get_args, get_origin from fastapi import FastAPI from pydantic import Field, create_model +from llama_stack.log import get_logger from llama_stack_api import Api from . import app as app_module -from .state import _dynamic_models, _extra_body_fields +from .state import _extra_body_fields, register_dynamic_model + +logger = get_logger(name=__name__, category="core") + + +def _to_pascal_case(segment: str) -> str: + tokens = re.findall(r"[A-Za-z]+|\d+", segment) + return "".join(token.capitalize() for token in tokens if token) + + +def _compose_request_model_name(webmethod, http_method: str, variant: str | None = None) -> str: + segments = [] + level = (webmethod.level or "").lower() + if level and level != "v1": + segments.append(_to_pascal_case(str(webmethod.level))) + for part in filter(None, webmethod.route.split("/")): + lower_part = part.lower() + if lower_part in {"v1", "v1alpha", "v1beta"}: + continue + if part.startswith("{"): + param = part[1:].split(":", 1)[0] + segments.append(f"By{_to_pascal_case(param)}") + else: + segments.append(_to_pascal_case(part)) + if not segments: + segments.append("Root") + base_name = "".join(segments) + http_method.title() + "Request" + if variant: + base_name = f"{base_name}{variant}" + return base_name def _extract_path_parameters(path: str) -> list[dict[str, Any]]: @@ -99,21 +128,21 @@ def _build_field_definitions(query_parameters: list[tuple[str, type, Any]], use_ def _create_dynamic_request_model( - webmethod, query_parameters: list[tuple[str, type, Any]], use_any: bool = False, add_uuid: bool = False + api: Api, + webmethod, + http_method: str, + query_parameters: list[tuple[str, type, Any]], + use_any: bool = False, + variant_suffix: str | None = None, ) -> type | None: """Create a dynamic Pydantic model for request body.""" try: field_definitions = _build_field_definitions(query_parameters, use_any) if not field_definitions: return None - clean_route = webmethod.route.replace("/", "_").replace("{", "").replace("}", "").replace("-", "_") - model_name = f"{clean_route}_Request" - if add_uuid: - model_name = f"{model_name}_{uuid.uuid4().hex[:8]}" - + model_name = _compose_request_model_name(webmethod, http_method, variant_suffix) request_model = create_model(model_name, **field_definitions) - _dynamic_models.append(request_model) - return request_model + return register_dynamic_model(model_name, request_model) except Exception: return None @@ -190,7 +219,7 @@ def _is_file_or_form_param(param_type: Any) -> bool: def _is_extra_body_field(metadata_item: Any) -> bool: """Check if a metadata item is an ExtraBodyField instance.""" - from llama_stack.schema_utils import ExtraBodyField + from llama_stack_api.schema_utils import ExtraBodyField return isinstance(metadata_item, ExtraBodyField) @@ -232,7 +261,7 @@ def _extract_response_models_from_union(union_type: Any) -> tuple[type | None, t streaming_model = inner_type else: # Might be a registered schema - check if it's registered - from llama_stack.schema_utils import _registered_schemas + from llama_stack_api.schema_utils import _registered_schemas if inner_type in _registered_schemas: # We'll need to look this up later, but for now store the type @@ -247,7 +276,7 @@ def _extract_response_models_from_union(union_type: Any) -> tuple[type | None, t def _find_models_for_endpoint( webmethod, api: Api, method_name: str, is_post_put: bool = False -) -> tuple[type | None, type | None, list[tuple[str, type, Any]], list[inspect.Parameter], type | None]: +) -> tuple[type | None, type | None, list[tuple[str, type, Any]], list[inspect.Parameter], type | None, str | None]: """ Find appropriate request and response models for an endpoint by analyzing the actual function signature. This uses the protocol function to determine the correct models dynamically. @@ -259,16 +288,18 @@ def _find_models_for_endpoint( is_post_put: Whether this is a POST, PUT, or PATCH request (GET requests should never have request bodies) Returns: - tuple: (request_model, response_model, query_parameters, file_form_params, streaming_response_model) + tuple: (request_model, response_model, query_parameters, file_form_params, streaming_response_model, response_schema_name) where query_parameters is a list of (name, type, default_value) tuples and file_form_params is a list of inspect.Parameter objects for File()/Form() params and streaming_response_model is the model for streaming responses (AsyncIterator content) """ + route_descriptor = f"{webmethod.method or 'UNKNOWN'} {webmethod.route}" try: # Get the function from the protocol func = app_module._get_protocol_method(api, method_name) if not func: - return None, None, [], [], None + logger.warning("No protocol method for %s.%s (%s)", api, method_name, route_descriptor) + return None, None, [], [], None, None # Analyze the function signature sig = inspect.signature(func) @@ -279,6 +310,7 @@ def _find_models_for_endpoint( file_form_params = [] path_params = set() extra_body_params = [] + response_schema_name = None # Extract path parameters from the route if webmethod and hasattr(webmethod, "route"): @@ -391,23 +423,49 @@ def _find_models_for_endpoint( elif origin is not None and (origin is types.UnionType or origin is typing.Union): # Handle union types - extract both non-streaming and streaming models response_model, streaming_response_model = _extract_response_models_from_union(return_annotation) + else: + try: + from fastapi import Response as FastAPIResponse + except ImportError: + FastAPIResponse = None + try: + from starlette.responses import Response as StarletteResponse + except ImportError: + StarletteResponse = None - return request_model, response_model, query_parameters, file_form_params, streaming_response_model + response_types = tuple(t for t in (FastAPIResponse, StarletteResponse) if t is not None) + if response_types and any(return_annotation is t for t in response_types): + response_schema_name = "Response" - except Exception: - # If we can't analyze the function signature, return None - return None, None, [], [], None + return request_model, response_model, query_parameters, file_form_params, streaming_response_model, response_schema_name + + except Exception as exc: + logger.warning( + "Failed to analyze endpoint %s.%s (%s): %s", api, method_name, route_descriptor, exc, exc_info=True + ) + return None, None, [], [], None, None def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): """Create a FastAPI endpoint from a discovered route and webmethod.""" path = route.path - methods = route.methods + raw_methods = route.methods or set() + method_list = sorted({method.upper() for method in raw_methods if method and method.upper() != "HEAD"}) + if not method_list: + method_list = ["GET"] + primary_method = method_list[0] name = route.name fastapi_path = path.replace("{", "{").replace("}", "}") - is_post_put = any(method.upper() in ["POST", "PUT", "PATCH"] for method in methods) + is_post_put = any(method in ["POST", "PUT", "PATCH"] for method in method_list) - request_model, response_model, query_parameters, file_form_params, streaming_response_model = ( + ( + request_model, + response_model, + query_parameters, + file_form_params, + streaming_response_model, + response_schema_name, + ) = ( _find_models_for_endpoint(webmethod, api, name, is_post_put) ) operation_description = _extract_operation_description_from_docstring(api, name) @@ -417,7 +475,7 @@ def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): func = app_module._get_protocol_method(api, name) extra_body_params = getattr(func, "_extra_body_params", []) if func else [] if extra_body_params: - for method in methods: + for method in method_list: key = (fastapi_path, method.upper()) _extra_body_fields[key] = extra_body_params @@ -447,12 +505,11 @@ def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): endpoint_func = _create_endpoint_with_request_model(request_model, response_model, operation_description) elif response_model and query_parameters: if is_post_put: - # Try creating request model with type preservation, fallback to Any, then minimal - request_model = _create_dynamic_request_model(webmethod, query_parameters, use_any=False) + request_model = _create_dynamic_request_model(api, webmethod, primary_method, query_parameters, use_any=False) if not request_model: - request_model = _create_dynamic_request_model(webmethod, query_parameters, use_any=True) - if not request_model: - request_model = _create_dynamic_request_model(webmethod, query_parameters, use_any=True, add_uuid=True) + request_model = _create_dynamic_request_model( + api, webmethod, primary_method, query_parameters, use_any=True, variant_suffix="Loose" + ) if request_model: endpoint_func = _create_endpoint_with_request_model( @@ -532,16 +589,18 @@ def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): endpoint_func = no_params_endpoint # Build response content with both application/json and text/event-stream if streaming - response_content = {} + response_content: dict[str, Any] = {} if response_model: response_content["application/json"] = {"schema": {"$ref": f"#/components/schemas/{response_model.__name__}"}} + elif response_schema_name: + response_content["application/json"] = {"schema": {"$ref": f"#/components/schemas/{response_schema_name}"}} if streaming_response_model: # Get the schema name for the streaming model # It might be a registered schema or a Pydantic model streaming_schema_name = None # Check if it's a registered schema first (before checking __name__) # because registered schemas might be Annotated types - from llama_stack.schema_utils import _registered_schemas + from llama_stack_api.schema_utils import _registered_schemas if streaming_response_model in _registered_schemas: streaming_schema_name = _registered_schemas[streaming_response_model]["name"] @@ -554,9 +613,6 @@ def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): } # If no content types, use empty schema - if not response_content: - response_content["application/json"] = {"schema": {}} - # Add the endpoint to the FastAPI app is_deprecated = webmethod.deprecated or False route_kwargs = { @@ -564,16 +620,16 @@ def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): "tags": [_get_tag_from_api(api)], "deprecated": is_deprecated, "responses": { - 200: { - "description": response_description, - "content": response_content, - }, 400: {"$ref": "#/components/responses/BadRequest400"}, 429: {"$ref": "#/components/responses/TooManyRequests429"}, 500: {"$ref": "#/components/responses/InternalServerError500"}, "default": {"$ref": "#/components/responses/DefaultError"}, }, } + success_response: dict[str, Any] = {"description": response_description} + if response_content: + success_response["content"] = response_content + route_kwargs["responses"][200] = success_response # FastAPI needs response_model parameter to properly generate OpenAPI spec # Use the non-streaming response model if available @@ -581,6 +637,6 @@ def _create_fastapi_endpoint(app: FastAPI, route, webmethod, api: Api): route_kwargs["response_model"] = response_model method_map = {"GET": app.get, "POST": app.post, "PUT": app.put, "DELETE": app.delete, "PATCH": app.patch} - for method in methods: - if handler := method_map.get(method.upper()): + for method in method_list: + if handler := method_map.get(method): handler(fastapi_path, **route_kwargs)(endpoint_func) diff --git a/scripts/openapi_generator/main.py b/scripts/openapi_generator/main.py index 623155784..e402d4d73 100755 --- a/scripts/openapi_generator/main.py +++ b/scripts/openapi_generator/main.py @@ -16,7 +16,7 @@ from typing import Any import yaml from fastapi.openapi.utils import get_openapi -from . import app, schema_collection, schema_filtering, schema_transforms +from . import app, schema_collection, schema_filtering, schema_transforms, state def generate_openapi_spec(output_dir: str) -> dict[str, Any]: @@ -29,6 +29,7 @@ def generate_openapi_spec(output_dir: str) -> dict[str, Any]: Returns: The generated OpenAPI specification as a dictionary """ + state.reset_generator_state() # Create the FastAPI app fastapi_app = app.create_llama_stack_app() @@ -143,7 +144,7 @@ def generate_openapi_spec(output_dir: str) -> dict[str, Any]: schema_transforms._fix_schema_issues(schema) schema_transforms._apply_legacy_sorting(schema) - print("\nšŸ” Validating generated schemas...") + print("\nValidating generated schemas...") failed_schemas = [ name for schema, name in schemas_to_validate if not schema_transforms.validate_openapi_schema(schema, name) ] @@ -186,20 +187,20 @@ def generate_openapi_spec(output_dir: str) -> dict[str, Any]: # Write the modified YAML back schema_transforms._write_yaml_file(yaml_path, yaml_data) - print(f"āœ… Generated YAML (stable): {yaml_path}") + print(f"Generated YAML (stable): {yaml_path}") experimental_yaml_path = output_path / "experimental-llama-stack-spec.yaml" schema_transforms._write_yaml_file(experimental_yaml_path, experimental_schema) - print(f"āœ… Generated YAML (experimental): {experimental_yaml_path}") + print(f"Generated YAML (experimental): {experimental_yaml_path}") deprecated_yaml_path = output_path / "deprecated-llama-stack-spec.yaml" schema_transforms._write_yaml_file(deprecated_yaml_path, deprecated_schema) - print(f"āœ… Generated YAML (deprecated): {deprecated_yaml_path}") + print(f"Generated YAML (deprecated): {deprecated_yaml_path}") # Generate combined (stainless) spec stainless_yaml_path = output_path / "stainless-llama-stack-spec.yaml" schema_transforms._write_yaml_file(stainless_yaml_path, combined_schema) - print(f"āœ… Generated YAML (stainless/combined): {stainless_yaml_path}") + print(f"Generated YAML (stainless/combined): {stainless_yaml_path}") return stable_schema @@ -213,25 +214,25 @@ def main(): args = parser.parse_args() - print("šŸš€ Generating OpenAPI specification using FastAPI...") - print(f"šŸ“ Output directory: {args.output_dir}") + print("Generating OpenAPI specification using FastAPI...") + print(f"Output directory: {args.output_dir}") try: openapi_schema = generate_openapi_spec(output_dir=args.output_dir) - print("\nāœ… OpenAPI specification generated successfully!") - print(f"šŸ“Š Schemas: {len(openapi_schema.get('components', {}).get('schemas', {}))}") - print(f"šŸ›£ļø Paths: {len(openapi_schema.get('paths', {}))}") + print("\nOpenAPI specification generated successfully!") + print(f"Schemas: {len(openapi_schema.get('components', {}).get('schemas', {}))}") + print(f"Paths: {len(openapi_schema.get('paths', {}))}") operation_count = sum( 1 for path_info in openapi_schema.get("paths", {}).values() for method in ["get", "post", "put", "delete", "patch"] if method in path_info ) - print(f"šŸ”§ Operations: {operation_count}") + print(f"Operations: {operation_count}") except Exception as e: - print(f"āŒ Error generating OpenAPI specification: {e}") + print(f"Error generating OpenAPI specification: {e}") raise diff --git a/scripts/openapi_generator/schema_transforms.py b/scripts/openapi_generator/schema_transforms.py index bd8cad64a..420a3dcc9 100644 --- a/scripts/openapi_generator/schema_transforms.py +++ b/scripts/openapi_generator/schema_transforms.py @@ -22,6 +22,9 @@ from ._legacy_order import ( LEGACY_PATH_ORDER, LEGACY_RESPONSE_ORDER, LEGACY_SCHEMA_ORDER, + LEGACY_OPERATION_KEYS, + LEGACY_SECURITY, + LEGACY_TAGS, LEGACY_TAG_GROUPS, LEGACY_TAG_ORDER, ) @@ -121,7 +124,7 @@ def _add_error_responses(openapi_schema: dict[str, Any]) -> dict[str, Any]: openapi_schema["components"]["responses"] = {} try: - from llama_stack.apis.datatypes import Error + from llama_stack_api.datatypes import Error schema_collection._ensure_components_schemas(openapi_schema) if "Error" not in openapi_schema["components"]["schemas"]: @@ -129,6 +132,10 @@ def _add_error_responses(openapi_schema: dict[str, Any]) -> dict[str, Any]: except ImportError: pass + schema_collection._ensure_components_schemas(openapi_schema) + if "Response" not in openapi_schema["components"]["schemas"]: + openapi_schema["components"]["schemas"]["Response"] = {"title": "Response", "type": "object"} + # Define standard HTTP error responses error_responses = { 400: { @@ -848,6 +855,20 @@ def _apply_legacy_sorting(openapi_schema: dict[str, Any]) -> dict[str, Any]: paths = openapi_schema.get("paths") if isinstance(paths, dict): openapi_schema["paths"] = order_mapping(paths, LEGACY_PATH_ORDER) + for path, path_item in openapi_schema["paths"].items(): + if not isinstance(path_item, dict): + continue + ordered_path_item = OrderedDict() + for method in ["get", "post", "put", "delete", "patch", "head", "options"]: + if method in path_item: + ordered_path_item[method] = order_mapping(path_item[method], LEGACY_OPERATION_KEYS) + for key, value in path_item.items(): + if key not in ordered_path_item: + if isinstance(value, dict) and key.lower() in {"get", "post", "put", "delete", "patch", "head", "options"}: + ordered_path_item[key] = order_mapping(value, LEGACY_OPERATION_KEYS) + else: + ordered_path_item[key] = value + openapi_schema["paths"][path] = ordered_path_item components = openapi_schema.setdefault("components", {}) schemas = components.get("schemas") @@ -857,30 +878,14 @@ def _apply_legacy_sorting(openapi_schema: dict[str, Any]) -> dict[str, Any]: if isinstance(responses, dict): components["responses"] = order_mapping(responses, LEGACY_RESPONSE_ORDER) - tags = openapi_schema.get("tags") - if isinstance(tags, list): - tag_priority = {name: idx for idx, name in enumerate(LEGACY_TAG_ORDER)} + if LEGACY_TAGS: + openapi_schema["tags"] = LEGACY_TAGS - def tag_sort(tag_obj: dict[str, Any]) -> tuple[int, int | str]: - name = tag_obj.get("name", "") - if name in tag_priority: - return (0, tag_priority[name]) - return (1, name) + if LEGACY_TAG_GROUPS: + openapi_schema["x-tagGroups"] = LEGACY_TAG_GROUPS - openapi_schema["tags"] = sorted(tags, key=tag_sort) - - tag_groups = openapi_schema.get("x-tagGroups") - if isinstance(tag_groups, list) and LEGACY_TAG_GROUPS: - legacy_tags = LEGACY_TAG_GROUPS[0].get("tags", []) - tag_priority = {name: idx for idx, name in enumerate(legacy_tags)} - for group in tag_groups: - group_tags = group.get("tags") - if isinstance(group_tags, list): - group["tags"] = sorted( - group_tags, - key=lambda name: (0, tag_priority[name]) if name in tag_priority else (1, name), - ) - openapi_schema["x-tagGroups"] = tag_groups + if LEGACY_SECURITY: + openapi_schema["security"] = LEGACY_SECURITY return openapi_schema @@ -914,12 +919,11 @@ def validate_openapi_schema(schema: dict[str, Any], schema_name: str = "OpenAPI """ try: validate_spec(schema) - print(f"āœ… {schema_name} is valid") + print(f"{schema_name} is valid") return True except OpenAPISpecValidatorError as e: - print(f"āŒ {schema_name} validation failed:") - print(f" {e}") + print(f"{schema_name} validation failed: {e}") return False except Exception as e: - print(f"āŒ {schema_name} validation error: {e}") + print(f"{schema_name} validation error: {e}") return False diff --git a/scripts/openapi_generator/state.py b/scripts/openapi_generator/state.py index b1c8f8edd..84bba1b45 100644 --- a/scripts/openapi_generator/state.py +++ b/scripts/openapi_generator/state.py @@ -14,6 +14,7 @@ from llama_stack_api import Api # Global list to store dynamic models created during endpoint generation _dynamic_models: list[Any] = [] +_dynamic_model_registry: dict[str, type] = {} # Cache for protocol methods to avoid repeated lookups _protocol_methods_cache: dict[Api, dict[str, Any]] | None = None @@ -21,3 +22,20 @@ _protocol_methods_cache: dict[Api, dict[str, Any]] | None = None # Global dict to store extra body field information by endpoint # Key: (path, method) tuple, Value: list of (param_name, param_type, description) tuples _extra_body_fields: dict[tuple[str, str], list[tuple[str, type, str | None]]] = {} + + +def register_dynamic_model(name: str, model: type) -> type: + """Register and deduplicate dynamically generated request models.""" + existing = _dynamic_model_registry.get(name) + if existing is not None: + return existing + _dynamic_model_registry[name] = model + _dynamic_models.append(model) + return model + + +def reset_generator_state() -> None: + """Clear per-run caches so repeated generations stay deterministic.""" + _dynamic_models.clear() + _dynamic_model_registry.clear() + _extra_body_fields.clear()