From 0d65bbc9e41bb8d28850e17466fcb6cedf9c7327 Mon Sep 17 00:00:00 2001 From: Eric Huang Date: Fri, 7 Nov 2025 11:27:17 -0800 Subject: [PATCH] file content fix # What does this PR do? ## Test Plan --- client-sdks/stainless/openapi.yml | 53 +- docs/static/llama-stack-spec.yaml | 7475 ++++++-------- docs/static/stainless-llama-stack-spec.yaml | 8695 +++++++---------- src/llama_stack/apis/vector_io/vector_io.py | 24 +- src/llama_stack/core/routers/vector_io.py | 4 +- .../core/routing_tables/vector_stores.py | 4 +- .../utils/memory/openai_vector_store_mixin.py | 15 +- .../vector_io/test_openai_vector_stores.py | 16 +- 8 files changed, 7094 insertions(+), 9192 deletions(-) diff --git a/client-sdks/stainless/openapi.yml b/client-sdks/stainless/openapi.yml index 448b08908..e7e9e5c11 100644 --- a/client-sdks/stainless/openapi.yml +++ b/client-sdks/stainless/openapi.yml @@ -2916,11 +2916,11 @@ paths: responses: '200': description: >- - A list of InterleavedContent representing the file contents. + Represents the parsed content of a vector store file. content: application/json: schema: - $ref: '#/components/schemas/VectorStoreFileContentsResponse' + $ref: '#/components/schemas/VectorStoreFileContentResponse' '400': $ref: '#/components/responses/BadRequest400' '429': @@ -10463,41 +10463,36 @@ components: title: VectorStoreContent description: >- Content item from a vector store file or search result. - VectorStoreFileContentsResponse: + VectorStoreFileContentResponse: type: object + description: Represents the parsed content of a vector store file. properties: - file_id: + object: type: string - description: Unique identifier for the file - filename: - type: string - description: Name of the file - attributes: - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Key-value attributes associated with the file - content: + enum: + - vector_store.file_content.page + description: The object type, which is always `vector_store.file_content.page` + x-stainless-const: true + data: type: array + description: Parsed content of the file. items: $ref: '#/components/schemas/VectorStoreContent' - description: List of content items from the file + has_more: + type: boolean + description: Indicates if there are more content pages to fetch. + next_page: + anyOf: + - type: string + description: The token for the next page, if any. + - type: 'null' additionalProperties: false required: - - file_id - - filename - - attributes - - content - title: VectorStoreFileContentsResponse - description: >- - Response from retrieving the contents of a vector store file. + - object + - data + - has_more + - next_page + title: VectorStoreFileContentResponse OpenaiSearchVectorStoreRequest: type: object properties: diff --git a/docs/static/llama-stack-spec.yaml b/docs/static/llama-stack-spec.yaml index cc720ad18..e34c57cf0 100644 --- a/docs/static/llama-stack-spec.yaml +++ b/docs/static/llama-stack-spec.yaml @@ -2,15 +2,12 @@ openapi: 3.1.0 info: title: Llama Stack Specification version: v1 - description: >- - This is the specification of the Llama Stack that provides - a set of endpoints and their corresponding interfaces that are - tailored to - best leverage Llama Models. - - **✅ STABLE**: Production-ready APIs with backward compatibility guarantees. + description: "This is the specification of the Llama Stack that provides\n \ + \ a set of endpoints and their corresponding interfaces that are\ntailored\ + \ to\n best leverage Llama Models.\n\n**\u2705 STABLE**: Production-ready\ + \ APIs with backward compatibility guarantees." servers: - - url: http://any-hosted-llama-stack.com +- url: http://any-hosted-llama-stack.com paths: /v1/batches: get: @@ -24,32 +21,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches + - Batches summary: List all batches for the current user. description: List all batches for the current user. parameters: - - name: after - in: query - description: >- - A cursor for pagination; returns batches after this batch ID. - required: false - schema: - type: string - - name: limit - in: query - description: >- - Number of batches to return (default 20, max 100). - required: true - schema: - type: integer + - name: after + in: query + description: A cursor for pagination; returns batches after this batch ID. + required: false + schema: + type: string + - name: limit + in: query + description: Number of batches to return (default 20, max 100). + required: true + schema: + type: integer deprecated: false post: responses: @@ -62,19 +55,15 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches - summary: >- - Create a new batch for processing multiple API requests. - description: >- - Create a new batch for processing multiple API requests. + - Batches + summary: Create a new batch for processing multiple API requests. + description: Create a new batch for processing multiple API requests. parameters: [] requestBody: content: @@ -95,26 +84,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches - summary: >- - Retrieve information about a specific batch. - description: >- - Retrieve information about a specific batch. + - Batches + summary: Retrieve information about a specific batch. + description: Retrieve information about a specific batch. parameters: - - name: batch_id - in: path - description: The ID of the batch to retrieve. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the batch to retrieve. + required: true + schema: + type: string deprecated: false /v1/batches/{batch_id}/cancel: post: @@ -128,24 +113,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches + - Batches summary: Cancel a batch that is in progress. description: Cancel a batch that is in progress. parameters: - - name: batch_id - in: path - description: The ID of the batch to cancel. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the batch to cancel. + required: true + schema: + type: string deprecated: false /v1/chat/completions: get: @@ -159,46 +142,41 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: List chat completions. description: List chat completions. parameters: - - name: after - in: query - description: >- - The ID of the last chat completion to return. - required: false - schema: - type: string - - name: limit - in: query - description: >- - The maximum number of chat completions to return. - required: false - schema: - type: integer - - name: model - in: query - description: The model to filter by. - required: false - schema: - type: string - - name: order - in: query - description: >- - The order to sort the chat completions by: "asc" or "desc". Defaults to - "desc". - required: false - schema: - $ref: '#/components/schemas/Order' + - name: after + in: query + description: The ID of the last chat completion to return. + required: false + schema: + type: string + - name: limit + in: query + description: The maximum number of chat completions to return. + required: false + schema: + type: integer + - name: model + in: query + description: The model to filter by. + required: false + schema: + type: string + - name: order + in: query + description: 'The order to sort the chat completions by: "asc" or "desc". + Defaults to "desc".' + required: false + schema: + $ref: '#/components/schemas/Order' deprecated: false post: responses: @@ -208,26 +186,23 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletion' - - $ref: '#/components/schemas/OpenAIChatCompletionChunk' + - $ref: '#/components/schemas/OpenAIChatCompletion' + - $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Create chat completions. - description: >- - Create chat completions. + description: 'Create chat completions. Generate an OpenAI-compatible chat completion for the given messages using - the specified model. + the specified model.' parameters: [] requestBody: content: @@ -248,27 +223,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Get chat completion. - description: >- - Get chat completion. + description: 'Get chat completion. - Describe a chat completion by its ID. + Describe a chat completion by its ID.' parameters: - - name: completion_id - in: path - description: ID of the chat completion. - required: true - schema: - type: string + - name: completion_id + in: path + description: ID of the chat completion. + required: true + schema: + type: string deprecated: false /v1/completions: post: @@ -282,21 +254,18 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Create completion. - description: >- - Create completion. + description: 'Create completion. Generate an OpenAI-compatible completion for the given prompt using the specified - model. + model.' parameters: [] requestBody: content: @@ -317,20 +286,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Create a conversation. - description: >- - Create a conversation. + description: 'Create a conversation. - Create a conversation. + Create a conversation.' parameters: [] requestBody: content: @@ -351,27 +317,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Retrieve a conversation. - description: >- - Retrieve a conversation. + description: 'Retrieve a conversation. - Get a conversation with the given ID. + Get a conversation with the given ID.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string deprecated: false post: responses: @@ -384,27 +347,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Update a conversation. - description: >- - Update a conversation. + description: 'Update a conversation. - Update a conversation's metadata with the given ID. + Update a conversation''s metadata with the given ID.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string requestBody: content: application/json: @@ -423,27 +383,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Delete a conversation. - description: >- - Delete a conversation. + description: 'Delete a conversation. - Delete a conversation with the given ID. + Delete a conversation with the given ID.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string deprecated: false /v1/conversations/{conversation_id}/items: get: @@ -457,71 +414,64 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: List items. - description: >- - List items. + description: 'List items. - List items in the conversation. + List items in the conversation.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - - name: after - in: query - description: >- - An item ID to list items after, used in pagination. - required: false - schema: - type: string - - name: include - in: query - description: >- - Specify additional output data to include in the response. - required: false - schema: - type: array - items: - 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. - - name: limit - in: query - description: >- - A limit on the number of objects to be returned (1-100, default 20). - required: false - schema: - type: integer - - name: order - in: query - description: >- - The order to return items in (asc or desc, default desc). - required: false - schema: + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string + - name: after + in: query + description: An item ID to list items after, used in pagination. + required: false + schema: + type: string + - name: include + in: query + description: Specify additional output data to include in the response. + required: false + schema: + type: array + items: type: string enum: - - asc - - desc + - 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. + - name: limit + in: query + description: A limit on the number of objects to be returned (1-100, default + 20). + required: false + schema: + type: integer + - name: order + in: query + description: The order to return items in (asc or desc, default desc). + required: false + schema: + type: string + enum: + - asc + - desc deprecated: false post: responses: @@ -534,27 +484,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Create items. - description: >- - Create items. + description: 'Create items. - Create items in the conversation. + Create items in the conversation.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string requestBody: content: application/json: @@ -574,33 +521,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Retrieve an item. - description: >- - Retrieve an item. + description: 'Retrieve an item. - Retrieve a conversation item. + Retrieve a conversation item.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - - name: item_id - in: path - description: The item identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string + - name: item_id + in: path + description: The item identifier. + required: true + schema: + type: string deprecated: false delete: responses: @@ -613,40 +557,36 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Delete an item. - description: >- - Delete an item. + description: 'Delete an item. - Delete a conversation item. + Delete a conversation item.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - - name: item_id - in: path - description: The item identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string + - name: item_id + in: path + description: The item identifier. + required: true + schema: + type: string deprecated: false /v1/embeddings: post: responses: '200': - description: >- - An OpenAIEmbeddingsResponse containing the embeddings. + description: An OpenAIEmbeddingsResponse containing the embeddings. content: application/json: schema: @@ -654,21 +594,18 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Create embeddings. - description: >- - Create embeddings. + description: 'Create embeddings. Generate OpenAI-compatible embeddings for the given input using the specified - model. + model.' parameters: [] requestBody: content: @@ -681,8 +618,7 @@ paths: get: responses: '200': - description: >- - An ListOpenAIFileResponse containing the list of files. + description: An ListOpenAIFileResponse containing the list of files. content: application/json: schema: @@ -690,60 +626,52 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: List files. - description: >- - List files. + description: 'List files. - Returns a list of files that belong to the user's organization. + Returns a list of files that belong to the user''s organization.' parameters: - - name: after - in: query - description: >- - A cursor for use in pagination. `after` is an object ID that defines your - place in the list. For instance, if you make a list request and receive - 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo - in order to fetch the next page of the list. - required: false - schema: - type: string - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 10,000, and the default is 10,000. - required: false - schema: - type: integer - - name: order - in: query - description: >- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending - order and `desc` for descending order. - required: false - schema: - $ref: '#/components/schemas/Order' - - name: purpose - in: query - description: >- - Only return files with the given purpose. - required: false - schema: - $ref: '#/components/schemas/OpenAIFilePurpose' + - name: after + in: query + description: A cursor for use in pagination. `after` is an object ID that + defines your place in the list. For instance, if you make a list request + and receive 100 objects, ending with obj_foo, your subsequent call can include + after=obj_foo in order to fetch the next page of the list. + required: false + schema: + type: string + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 10,000, and the default is 10,000. + required: false + schema: + type: integer + - name: order + in: query + description: Sort order by the `created_at` timestamp of the objects. `asc` + for ascending order and `desc` for descending order. + required: false + schema: + $ref: '#/components/schemas/Order' + - name: purpose + in: query + description: Only return files with the given purpose. + required: false + schema: + $ref: '#/components/schemas/OpenAIFilePurpose' deprecated: false post: responses: '200': - description: >- - An OpenAIFileObject representing the uploaded file. + description: An OpenAIFileObject representing the uploaded file. content: application/json: schema: @@ -751,18 +679,15 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Upload file. - description: >- - Upload file. + description: 'Upload file. Upload a file that can be used across various endpoints. @@ -773,7 +698,7 @@ paths: - purpose: The intended purpose of the uploaded file. - - expires_after: Optional form values describing expiration for the file. + - expires_after: Optional form values describing expiration for the file.' parameters: [] requestBody: content: @@ -789,16 +714,15 @@ paths: expires_after: $ref: '#/components/schemas/ExpiresAfter' required: - - file - - purpose + - file + - purpose required: true deprecated: false /v1/files/{file_id}: get: responses: '200': - description: >- - An OpenAIFileObject containing file information. + description: An OpenAIFileObject containing file information. content: application/json: schema: @@ -806,34 +730,29 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Retrieve file. - description: >- - Retrieve file. + description: 'Retrieve file. - Returns information about a specific file. + Returns information about a specific file.' parameters: - - name: file_id - in: path - description: >- - The ID of the file to use for this request. - required: true - schema: - type: string + - name: file_id + in: path + description: The ID of the file to use for this request. + required: true + schema: + type: string deprecated: false delete: responses: '200': - description: >- - An OpenAIFileDeleteResponse indicating successful deletion. + description: An OpenAIFileDeleteResponse indicating successful deletion. content: application/json: schema: @@ -841,32 +760,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Delete file. description: Delete file. parameters: - - name: file_id - in: path - description: >- - The ID of the file to use for this request. - required: true - schema: - type: string + - name: file_id + in: path + description: The ID of the file to use for this request. + required: true + schema: + type: string deprecated: false /v1/files/{file_id}/content: get: responses: '200': - description: >- - The raw file content as a binary response. + description: The raw file content as a binary response. content: application/json: schema: @@ -874,35 +789,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Retrieve file content. - description: >- - Retrieve file content. + description: 'Retrieve file content. - Returns the contents of the specified file. + Returns the contents of the specified file.' parameters: - - name: file_id - in: path - description: >- - The ID of the file to use for this request. - required: true - schema: - type: string + - name: file_id + in: path + description: The ID of the file to use for this request. + required: true + schema: + type: string deprecated: false /v1/health: get: responses: '200': - description: >- - Health information indicating if the service is operational. + description: Health information indicating if the service is operational. content: application/json: schema: @@ -910,28 +820,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inspect + - Inspect summary: Get health status. - description: >- - Get health status. + description: 'Get health status. - Get the current health status of the service. + Get the current health status of the service.' parameters: [] deprecated: false /v1/inspect/routes: get: responses: '200': - description: >- - Response containing information about all available routes. + description: Response containing information about all available routes. content: application/json: schema: @@ -939,36 +845,32 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inspect + - Inspect summary: List routes. - description: >- - List routes. + description: 'List routes. - List all available API routes with their methods and implementing providers. + List all available API routes with their methods and implementing providers.' parameters: - - name: api_filter - in: query - description: >- - Optional filter to control which routes are returned. Can be an API level - ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at that level, - or 'deprecated' to show deprecated routes across all levels. If not specified, - returns only non-deprecated v1 routes. - required: false - schema: - type: string - enum: - - v1 - - v1alpha - - v1beta - - deprecated + - name: api_filter + in: query + description: Optional filter to control which routes are returned. Can be + an API level ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at + that level, or 'deprecated' to show deprecated routes across all levels. + If not specified, returns only non-deprecated v1 routes. + required: false + schema: + type: string + enum: + - v1 + - v1alpha + - v1beta + - deprecated deprecated: false /v1/models: get: @@ -982,15 +884,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: List models using the OpenAI API. description: List models using the OpenAI API. parameters: [] @@ -1006,20 +906,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: Register model. - description: >- - Register model. + description: 'Register model. - Register a model. + Register a model.' parameters: [] requestBody: content: @@ -1040,27 +937,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: Get model. - description: >- - Get model. + description: 'Get model. - Get a model by its identifier. + Get a model by its identifier.' parameters: - - name: model_id - in: path - description: The identifier of the model to get. - required: true - schema: - type: string + - name: model_id + in: path + description: The identifier of the model to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1069,28 +963,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: Unregister model. - description: >- - Unregister model. + description: 'Unregister model. - Unregister a model. + Unregister a model.' parameters: - - name: model_id - in: path - description: >- - The identifier of the model to unregister. - required: true - schema: - type: string + - name: model_id + in: path + description: The identifier of the model to unregister. + required: true + schema: + type: string deprecated: false /v1/moderations: post: @@ -1104,20 +994,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Safety + - Safety summary: Create moderation. - description: >- - Create moderation. + description: 'Create moderation. - Classifies if text and/or image inputs are potentially harmful. + Classifies if text and/or image inputs are potentially harmful.' parameters: [] requestBody: content: @@ -1130,8 +1017,7 @@ paths: get: responses: '200': - description: >- - A ListPromptsResponse containing all prompts. + description: A ListPromptsResponse containing all prompts. content: application/json: schema: @@ -1139,15 +1025,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: List all prompts. description: List all prompts. parameters: [] @@ -1163,20 +1047,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Create prompt. - description: >- - Create prompt. + description: 'Create prompt. - Create a new prompt. + Create a new prompt.' parameters: [] requestBody: content: @@ -1197,40 +1078,35 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Get prompt. - description: >- - Get prompt. + description: 'Get prompt. - Get a prompt by its identifier and optional version. + Get a prompt by its identifier and optional version.' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt to get. - required: true - schema: - type: string - - name: version - in: query - description: >- - The version of the prompt to get (defaults to latest). - required: false - schema: - type: integer + - name: prompt_id + in: path + description: The identifier of the prompt to get. + required: true + schema: + type: string + - name: version + in: query + description: The version of the prompt to get (defaults to latest). + required: false + schema: + type: integer deprecated: false post: responses: '200': - description: >- - The updated Prompt resource with incremented version. + description: The updated Prompt resource with incremented version. content: application/json: schema: @@ -1238,27 +1114,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Update prompt. - description: >- - Update prompt. + description: 'Update prompt. - Update an existing prompt (increments version). + Update an existing prompt (increments version).' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt to update. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt to update. + required: true + schema: + type: string requestBody: content: application/json: @@ -1273,34 +1146,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Delete prompt. - description: >- - Delete prompt. + description: 'Delete prompt. - Delete a prompt. + Delete a prompt.' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt to delete. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt to delete. + required: true + schema: + type: string deprecated: false /v1/prompts/{prompt_id}/set-default-version: post: responses: '200': - description: >- - The prompt with the specified version now set as default. + description: The prompt with the specified version now set as default. content: application/json: schema: @@ -1308,27 +1177,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Set prompt version. - description: >- - Set prompt version. + description: 'Set prompt version. - Set which version of a prompt should be the default in get_prompt (latest). + Set which version of a prompt should be the default in get_prompt (latest).' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt. + required: true + schema: + type: string requestBody: content: application/json: @@ -1340,8 +1206,7 @@ paths: get: responses: '200': - description: >- - A ListPromptsResponse containing all versions of the prompt. + description: A ListPromptsResponse containing all versions of the prompt. content: application/json: schema: @@ -1349,35 +1214,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: List prompt versions. - description: >- - List prompt versions. + description: 'List prompt versions. - List all versions of a specific prompt. + List all versions of a specific prompt.' parameters: - - name: prompt_id - in: path - description: >- - The identifier of the prompt to list versions for. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt to list versions for. + required: true + schema: + type: string deprecated: false /v1/providers: get: responses: '200': - description: >- - A ListProvidersResponse containing information about all providers. + description: A ListProvidersResponse containing information about all providers. content: application/json: schema: @@ -1385,28 +1245,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Providers + - Providers summary: List providers. - description: >- - List providers. + description: 'List providers. - List all available providers. + List all available providers.' parameters: [] deprecated: false /v1/providers/{provider_id}: get: responses: '200': - description: >- - A ProviderInfo object containing the provider's details. + description: A ProviderInfo object containing the provider's details. content: application/json: schema: @@ -1414,27 +1270,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Providers + - Providers summary: Get provider. - description: >- - Get provider. + description: 'Get provider. - Get detailed information about a specific provider. + Get detailed information about a specific provider.' parameters: - - name: provider_id - in: path - description: The ID of the provider to inspect. - required: true - schema: - type: string + - name: provider_id + in: path + description: The ID of the provider to inspect. + required: true + schema: + type: string deprecated: false /v1/responses: get: @@ -1448,43 +1301,41 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: List all responses. description: List all responses. parameters: - - name: after - in: query - description: The ID of the last response to return. - required: false - schema: - type: string - - name: limit - in: query - description: The number of responses to return. - required: false - schema: - type: integer - - name: model - in: query - description: The model to filter responses by. - required: false - schema: - type: string - - name: order - in: query - description: >- - The order to sort responses by when sorted by created_at ('asc' or 'desc'). - required: false - schema: - $ref: '#/components/schemas/Order' + - name: after + in: query + description: The ID of the last response to return. + required: false + schema: + type: string + - name: limit + in: query + description: The number of responses to return. + required: false + schema: + type: integer + - name: model + in: query + description: The model to filter responses by. + required: false + schema: + type: string + - name: order + in: query + description: The order to sort responses by when sorted by created_at ('asc' + or 'desc'). + required: false + schema: + $ref: '#/components/schemas/Order' deprecated: false post: responses: @@ -1500,15 +1351,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: Create a model response. description: Create a model response. parameters: [] @@ -1520,17 +1369,16 @@ paths: required: true deprecated: false x-llama-stack-extra-body-params: - - name: guardrails - schema: - type: array - items: - oneOf: - - type: string - - $ref: '#/components/schemas/ResponseGuardrailSpec' - description: >- - List of guardrails to apply during response generation. Guardrails provide - safety and content moderation. - required: false + - name: guardrails + schema: + type: array + items: + oneOf: + - type: string + - $ref: '#/components/schemas/ResponseGuardrailSpec' + description: List of guardrails to apply during response generation. Guardrails + provide safety and content moderation. + required: false /v1/responses/{response_id}: get: responses: @@ -1543,25 +1391,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: Get a model response. description: Get a model response. parameters: - - name: response_id - in: path - description: >- - The ID of the OpenAI response to retrieve. - required: true - schema: - type: string + - name: response_id + in: path + description: The ID of the OpenAI response to retrieve. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1574,24 +1419,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: Delete a response. description: Delete a response. parameters: - - name: response_id - in: path - description: The ID of the OpenAI response to delete. - required: true - schema: - type: string + - name: response_id + in: path + description: The ID of the OpenAI response to delete. + required: true + schema: + type: string deprecated: false /v1/responses/{response_id}/input_items: get: @@ -1605,63 +1448,55 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: List input items. description: List input items. parameters: - - name: response_id - in: path - description: >- - The ID of the response to retrieve input items for. - required: true - schema: + - name: response_id + in: path + description: The ID of the response to retrieve input items for. + required: true + schema: + type: string + - name: after + in: query + description: An item ID to list items after, used for pagination. + required: false + schema: + type: string + - name: before + in: query + description: An item ID to list items before, used for pagination. + required: false + schema: + type: string + - name: include + in: query + description: Additional fields to include in the response. + required: false + schema: + type: array + items: type: string - - name: after - in: query - description: >- - An item ID to list items after, used for pagination. - required: false - schema: - type: string - - name: before - in: query - description: >- - An item ID to list items before, used for pagination. - required: false - schema: - type: string - - name: include - in: query - description: >- - Additional fields to include in the response. - required: false - schema: - type: array - items: - type: string - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - The order to return the input items in. Default is desc. - required: false - schema: - $ref: '#/components/schemas/Order' + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: The order to return the input items in. Default is desc. + required: false + schema: + $ref: '#/components/schemas/Order' deprecated: false /v1/safety/run-shield: post: @@ -1675,20 +1510,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Safety + - Safety summary: Run shield. - description: >- - Run shield. + description: 'Run shield. - Run a shield. + Run a shield.' parameters: [] requestBody: content: @@ -1709,15 +1541,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: List all scoring functions. description: List all scoring functions. parameters: [] @@ -1729,15 +1559,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: Register a scoring function. description: Register a scoring function. parameters: [] @@ -1760,24 +1588,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: Get a scoring function by its ID. description: Get a scoring function by its ID. parameters: - - name: scoring_fn_id - in: path - description: The ID of the scoring function to get. - required: true - schema: - type: string + - name: scoring_fn_id + in: path + description: The ID of the scoring function to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1786,32 +1612,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: Unregister a scoring function. description: Unregister a scoring function. parameters: - - name: scoring_fn_id - in: path - description: >- - The ID of the scoring function to unregister. - required: true - schema: - type: string + - name: scoring_fn_id + in: path + description: The ID of the scoring function to unregister. + required: true + schema: + type: string deprecated: false /v1/scoring/score: post: responses: '200': - description: >- - A ScoreResponse object containing rows and aggregated results. + description: A ScoreResponse object containing rows and aggregated results. content: application/json: schema: @@ -1819,15 +1641,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Scoring + - Scoring summary: Score a list of rows. description: Score a list of rows. parameters: [] @@ -1850,15 +1670,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Scoring + - Scoring summary: Score a batch of rows. description: Score a batch of rows. parameters: [] @@ -1881,15 +1699,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: List all shields. description: List all shields. parameters: [] @@ -1905,15 +1721,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: Register a shield. description: Register a shield. parameters: [] @@ -1936,24 +1750,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: Get a shield by its identifier. description: Get a shield by its identifier. parameters: - - name: identifier - in: path - description: The identifier of the shield to get. - required: true - schema: - type: string + - name: identifier + in: path + description: The identifier of the shield to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1962,25 +1774,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: Unregister a shield. description: Unregister a shield. parameters: - - name: identifier - in: path - description: >- - The identifier of the shield to unregister. - required: true - schema: - type: string + - name: identifier + in: path + description: The identifier of the shield to unregister. + required: true + schema: + type: string deprecated: false /v1/tool-runtime/invoke: post: @@ -1994,15 +1803,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolRuntime + - ToolRuntime summary: Run a tool with the given arguments. description: Run a tool with the given arguments. parameters: [] @@ -2025,32 +1832,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolRuntime + - ToolRuntime summary: List all tools in the runtime. description: List all tools in the runtime. parameters: - - name: tool_group_id - in: query - description: >- - The ID of the tool group to list tools for. - required: false - schema: - type: string - - name: mcp_endpoint - in: query - description: >- - The MCP endpoint to use for the tool group. - required: false - schema: - $ref: '#/components/schemas/URL' + - name: tool_group_id + in: query + description: The ID of the tool group to list tools for. + required: false + schema: + type: string + - name: mcp_endpoint + in: query + description: The MCP endpoint to use for the tool group. + required: false + schema: + $ref: '#/components/schemas/URL' deprecated: false /v1/toolgroups: get: @@ -2064,15 +1867,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: List tool groups with optional provider. description: List tool groups with optional provider. parameters: [] @@ -2084,15 +1885,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Register a tool group. description: Register a tool group. parameters: [] @@ -2115,24 +1914,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Get a tool group by its ID. description: Get a tool group by its ID. parameters: - - name: toolgroup_id - in: path - description: The ID of the tool group to get. - required: true - schema: - type: string + - name: toolgroup_id + in: path + description: The ID of the tool group to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -2141,24 +1938,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Unregister a tool group. description: Unregister a tool group. parameters: - - name: toolgroup_id - in: path - description: The ID of the tool group to unregister. - required: true - schema: - type: string + - name: toolgroup_id + in: path + description: The ID of the tool group to unregister. + required: true + schema: + type: string deprecated: false /v1/tools: get: @@ -2172,25 +1967,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: List tools with optional tool group. description: List tools with optional tool group. parameters: - - name: toolgroup_id - in: query - description: >- - The ID of the tool group to list tools for. - required: false - schema: - type: string + - name: toolgroup_id + in: query + description: The ID of the tool group to list tools for. + required: false + schema: + type: string deprecated: false /v1/tools/{tool_name}: get: @@ -2204,24 +1996,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Get a tool by its name. description: Get a tool by its name. parameters: - - name: tool_name - in: path - description: The name of the tool to get. - required: true - schema: - type: string + - name: tool_name + in: path + description: The name of the tool to get. + required: true + schema: + type: string deprecated: false /v1/vector-io/insert: post: @@ -2231,15 +2021,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Insert chunks into a vector database. description: Insert chunks into a vector database. parameters: [] @@ -2262,15 +2050,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Query chunks from a vector database. description: Query chunks from a vector database. parameters: [] @@ -2285,8 +2071,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreListResponse containing the list of vector stores. + description: A VectorStoreListResponse containing the list of vector stores. content: application/json: schema: @@ -2294,56 +2079,49 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Returns a list of vector stores. description: Returns a list of vector stores. parameters: - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending - order and `desc` for descending order. - required: false - schema: - type: string - - name: after - in: query - description: >- - A cursor for use in pagination. `after` is an object ID that defines your - place in the list. - required: false - schema: - type: string - - name: before - in: query - description: >- - A cursor for use in pagination. `before` is an object ID that defines - your place in the list. - required: false - schema: - type: string + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: Sort order by the `created_at` timestamp of the objects. `asc` + for ascending order and `desc` for descending order. + required: false + schema: + type: string + - name: after + in: query + description: A cursor for use in pagination. `after` is an object ID that + defines your place in the list. + required: false + schema: + type: string + - name: before + in: query + description: A cursor for use in pagination. `before` is an object ID that + defines your place in the list. + required: false + schema: + type: string deprecated: false post: responses: '200': - description: >- - A VectorStoreObject representing the created vector store. + description: A VectorStoreObject representing the created vector store. content: application/json: schema: @@ -2351,20 +2129,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Creates a vector store. - description: >- - Creates a vector store. + description: 'Creates a vector store. - Generate an OpenAI-compatible vector store with the given parameters. + Generate an OpenAI-compatible vector store with the given parameters.' parameters: [] requestBody: content: @@ -2377,8 +2152,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreObject representing the vector store. + description: A VectorStoreObject representing the vector store. content: application/json: schema: @@ -2386,30 +2160,27 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Retrieves a vector store. description: Retrieves a vector store. parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to retrieve. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to retrieve. + required: true + schema: + type: string deprecated: false post: responses: '200': - description: >- - A VectorStoreObject representing the updated vector store. + description: A VectorStoreObject representing the updated vector store. content: application/json: schema: @@ -2417,24 +2188,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Updates a vector store. description: Updates a vector store. parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to update. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to update. + required: true + schema: + type: string requestBody: content: application/json: @@ -2445,8 +2214,7 @@ paths: delete: responses: '200': - description: >- - A VectorStoreDeleteResponse indicating the deletion status. + description: A VectorStoreDeleteResponse indicating the deletion status. content: application/json: schema: @@ -2454,31 +2222,29 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Delete a vector store. description: Delete a vector store. parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to delete. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to delete. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/file_batches: post: responses: '200': - description: >- - A VectorStoreFileBatchObject representing the created file batch. + description: A VectorStoreFileBatchObject representing the created file + batch. content: application/json: schema: @@ -2486,29 +2252,25 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Create a vector store file batch. - description: >- - Create a vector store file batch. + description: 'Create a vector store file batch. Generate an OpenAI-compatible vector store file batch for the given vector - store. + store.' parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store to create the file batch for. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to create the file batch for. + required: true + schema: + type: string requestBody: content: application/json: @@ -2520,8 +2282,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreFileBatchObject representing the file batch. + description: A VectorStoreFileBatchObject representing the file batch. content: application/json: schema: @@ -2529,38 +2290,35 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Retrieve a vector store file batch. description: Retrieve a vector store file batch. parameters: - - name: batch_id - in: path - description: The ID of the file batch to retrieve. - required: true - schema: - type: string - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file batch. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the file batch to retrieve. + required: true + schema: + type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file batch. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: post: responses: '200': - description: >- - A VectorStoreFileBatchObject representing the cancelled file batch. + description: A VectorStoreFileBatchObject representing the cancelled file + batch. content: application/json: schema: @@ -2568,39 +2326,35 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Cancels a vector store file batch. description: Cancels a vector store file batch. parameters: - - name: batch_id - in: path - description: The ID of the file batch to cancel. - required: true - schema: - type: string - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file batch. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the file batch to cancel. + required: true + schema: + type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file batch. + required: true + schema: + type: string deprecated: false /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. + description: A VectorStoreFilesListInBatchResponse containing the list of + files in the batch. content: application/json: schema: @@ -2608,80 +2362,69 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO - summary: >- - Returns a list of vector store files in a batch. - description: >- - Returns a list of vector store files in a batch. + - VectorIO + summary: Returns a list of vector store files in a batch. + description: Returns a list of vector store files in a batch. parameters: - - name: batch_id - in: path - description: >- - The ID of the file batch to list files from. - required: true - schema: - type: string - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file batch. - required: true - schema: - type: string - - name: after - in: query - description: >- - A cursor for use in pagination. `after` is an object ID that defines your - place in the list. - required: false - schema: - type: string - - name: before - in: query - description: >- - A cursor for use in pagination. `before` is an object ID that defines - your place in the list. - required: false - schema: - type: string - - name: filter - in: query - description: >- - Filter by file status. One of in_progress, completed, failed, cancelled. - required: false - schema: - type: string - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending - order and `desc` for descending order. - required: false - schema: - type: string + - name: batch_id + in: path + description: The ID of the file batch to list files from. + required: true + schema: + type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file batch. + required: true + schema: + type: string + - name: after + in: query + description: A cursor for use in pagination. `after` is an object ID that + defines your place in the list. + required: false + schema: + type: string + - name: before + in: query + description: A cursor for use in pagination. `before` is an object ID that + defines your place in the list. + required: false + schema: + type: string + - name: filter + in: query + description: Filter by file status. One of in_progress, completed, failed, + cancelled. + required: false + schema: + type: string + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: Sort order by the `created_at` timestamp of the objects. `asc` + for ascending order and `desc` for descending order. + required: false + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/files: get: responses: '200': - description: >- - A VectorStoreListFilesResponse containing the list of files. + description: A VectorStoreListFilesResponse containing the list of files. content: application/json: schema: @@ -2689,71 +2432,62 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: List files in a vector store. description: List files in a vector store. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store to list files from. - required: true - schema: - type: string - - name: limit - in: query - description: >- - (Optional) A limit on the number of objects to be returned. Limit can - range between 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - (Optional) Sort order by the `created_at` timestamp of the objects. `asc` - for ascending order and `desc` for descending order. - required: false - schema: - type: string - - name: after - in: query - description: >- - (Optional) A cursor for use in pagination. `after` is an object ID that - defines your place in the list. - required: false - schema: - type: string - - name: before - in: query - description: >- - (Optional) A cursor for use in pagination. `before` is an object ID that - defines your place in the list. - required: false - schema: - type: string - - name: filter - in: query - description: >- - (Optional) Filter by file status to only return files with the specified - status. - required: false - schema: - $ref: '#/components/schemas/VectorStoreFileStatus' + - name: vector_store_id + in: path + description: The ID of the vector store to list files from. + required: true + schema: + type: string + - name: limit + in: query + description: (Optional) A limit on the number of objects to be returned. Limit + can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: (Optional) Sort order by the `created_at` timestamp of the objects. + `asc` for ascending order and `desc` for descending order. + required: false + schema: + type: string + - name: after + in: query + description: (Optional) A cursor for use in pagination. `after` is an object + ID that defines your place in the list. + required: false + schema: + type: string + - name: before + in: query + description: (Optional) A cursor for use in pagination. `before` is an object + ID that defines your place in the list. + required: false + schema: + type: string + - name: filter + in: query + description: (Optional) Filter by file status to only return files with the + specified status. + required: false + schema: + $ref: '#/components/schemas/VectorStoreFileStatus' deprecated: false post: responses: '200': - description: >- - A VectorStoreFileObject representing the attached file. + description: A VectorStoreFileObject representing the attached file. content: application/json: schema: @@ -2761,25 +2495,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Attach a file to a vector store. description: Attach a file to a vector store. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store to attach the file to. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to attach the file to. + required: true + schema: + type: string requestBody: content: application/json: @@ -2791,8 +2522,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreFileObject representing the file. + description: A VectorStoreFileObject representing the file. content: application/json: schema: @@ -2800,37 +2530,33 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Retrieves a vector store file. description: Retrieves a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to retrieve. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to retrieve. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to retrieve. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to retrieve. + required: true + schema: + type: string deprecated: false post: responses: '200': - description: >- - A VectorStoreFileObject representing the updated file. + description: A VectorStoreFileObject representing the updated file. content: application/json: schema: @@ -2838,31 +2564,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Updates a vector store file. description: Updates a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to update. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to update. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to update. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to update. + required: true + schema: + type: string requestBody: content: application/json: @@ -2873,8 +2596,7 @@ paths: delete: responses: '200': - description: >- - A VectorStoreFileDeleteResponse indicating the deletion status. + description: A VectorStoreFileDeleteResponse indicating the deletion status. content: application/json: schema: @@ -2882,79 +2604,69 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Delete a vector store file. description: Delete a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to delete. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to delete. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to delete. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to delete. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: responses: '200': - description: >- - A list of InterleavedContent representing the file contents. + description: A list of InterleavedContent representing the file contents. content: application/json: schema: - $ref: '#/components/schemas/VectorStoreFileContentsResponse' + $ref: '#/components/schemas/VectorStoreFileContentResponse' '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO - summary: >- - Retrieves the contents of a vector store file. - description: >- - Retrieves the contents of a vector store file. + - VectorIO + summary: Retrieves the contents of a vector store file. + description: Retrieves the contents of a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to retrieve. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to retrieve. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to retrieve. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to retrieve. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/search: post: responses: '200': - description: >- - A VectorStoreSearchResponse containing the search results. + description: A VectorStoreSearchResponse containing the search results. content: application/json: schema: @@ -2962,28 +2674,25 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Search for chunks in a vector store. - description: >- - Search for chunks in a 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. + file attribute filters.' parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to search. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to search. + required: true + schema: + type: string requestBody: content: application/json: @@ -2995,8 +2704,7 @@ paths: get: responses: '200': - description: >- - Version information containing the service version number. + description: Version information containing the service version number. content: application/json: schema: @@ -3004,24 +2712,20 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inspect + - Inspect summary: Get version. - description: >- - Get version. + description: 'Get version. - Get the version of the service. + Get the version of the service.' parameters: [] deprecated: false -jsonSchemaDialect: >- - https://json-schema.org/draft/2020-12/schema +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema components: schemas: Error: @@ -3032,26 +2736,22 @@ components: description: HTTP status code title: type: string - description: >- - Error title, a short summary of the error which is invariant for an error - type + description: Error title, a short summary of the error which is invariant + for an error type detail: type: string - description: >- - Error detail, a longer human-readable description of the error + description: Error detail, a longer human-readable description of the error instance: type: string - description: >- - (Optional) A URL which can be used to retrieve more information about - the specific occurrence of the error + description: (Optional) A URL which can be used to retrieve more information + about the specific occurrence of the error additionalProperties: false required: - - status - - title - - detail + - status + - title + - detail title: Error - description: >- - Error response from the API. Roughly follows RFC 7807. + description: Error response from the API. Roughly follows RFC 7807. ListBatchesResponse: type: object properties: @@ -3080,14 +2780,14 @@ components: status: type: string enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled cancelled_at: type: integer cancelling_at: @@ -3147,9 +2847,9 @@ components: type: integer additionalProperties: false required: - - completed - - failed - - total + - completed + - failed + - total title: BatchRequestCounts usage: type: object @@ -3163,7 +2863,7 @@ components: type: integer additionalProperties: false required: - - cached_tokens + - cached_tokens title: InputTokensDetails output_tokens: type: integer @@ -3174,27 +2874,27 @@ components: type: integer additionalProperties: false required: - - reasoning_tokens + - reasoning_tokens title: OutputTokensDetails total_tokens: type: integer additionalProperties: false required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens title: BatchUsage additionalProperties: false required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status title: Batch first_id: type: string @@ -3205,28 +2905,24 @@ components: default: false additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: ListBatchesResponse - description: >- - Response containing a list of batch objects. + description: Response containing a list of batch objects. CreateBatchRequest: type: object properties: input_file_id: type: string - description: >- - The ID of an uploaded file containing requests for the batch. + description: The ID of an uploaded file containing requests for the batch. endpoint: type: string - description: >- - The endpoint to be used for all requests in the batch. + description: The endpoint to be used for all requests in the batch. completion_window: type: string const: 24h - description: >- - The time window within which the batch should be processed. + description: The time window within which the batch should be processed. metadata: type: object additionalProperties: @@ -3234,13 +2930,13 @@ components: description: Optional metadata for the batch. idempotency_key: type: string - description: >- - Optional idempotency key. When provided, enables idempotent behavior. + description: Optional idempotency key. When provided, enables idempotent + behavior. additionalProperties: false required: - - input_file_id - - endpoint - - completion_window + - input_file_id + - endpoint + - completion_window title: CreateBatchRequest Batch: type: object @@ -3261,14 +2957,14 @@ components: status: type: string enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled cancelled_at: type: integer cancelling_at: @@ -3328,9 +3024,9 @@ components: type: integer additionalProperties: false required: - - completed - - failed - - total + - completed + - failed + - total title: BatchRequestCounts usage: type: object @@ -3344,7 +3040,7 @@ components: type: integer additionalProperties: false required: - - cached_tokens + - cached_tokens title: InputTokensDetails output_tokens: type: integer @@ -3355,33 +3051,33 @@ components: type: integer additionalProperties: false required: - - reasoning_tokens + - reasoning_tokens title: OutputTokensDetails total_tokens: type: integer additionalProperties: false required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens title: BatchUsage additionalProperties: false required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status title: Batch Order: type: string enum: - - asc - - desc + - asc + - desc title: Order description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: @@ -3404,39 +3100,34 @@ components: type: string const: chat.completion default: chat.completion - description: >- - The object type, which will be "chat.completion" + description: The object type, which will be "chat.completion" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion + was created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information for the completion + description: Token usage information for the completion input_messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' additionalProperties: false required: - - id - - choices - - object - - created - - model - - input_messages + - id + - choices + - object + - created + - model + - input_messages title: OpenAICompletionWithInputMessages - description: >- - List of chat completion objects with their input messages + description: List of chat completion objects with their input messages has_more: type: boolean - description: >- - Whether there are more completions available beyond this list + description: Whether there are more completions available beyond this list first_id: type: string description: ID of the first completion in this list @@ -3447,18 +3138,16 @@ components: type: string const: list default: list - description: >- - Must be "list" to identify this as a list response + description: Must be "list" to identify this as a list response additionalProperties: false required: - - data - - has_more - - first_id - - last_id - - object + - data + - has_more + - first_id + - last_id + - object title: ListOpenAIChatCompletionResponse - description: >- - Response from listing OpenAI-compatible chat completions. + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: type: object properties: @@ -3466,59 +3155,51 @@ components: type: string const: assistant default: assistant - description: >- - Must be "assistant" to identify this as the model's response + description: Must be "assistant" to identify this as the model's response content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The content of the model's response name: type: string - description: >- - (Optional) The name of the assistant message participant. + description: (Optional) The name of the assistant message participant. tool_calls: type: array items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - description: >- - List of tool calls. Each tool call is an OpenAIChatCompletionToolCall + description: List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. additionalProperties: false required: - - role + - role title: OpenAIAssistantMessageParam - description: >- - A message containing the model's (assistant) response in an OpenAI-compatible + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - "OpenAIChatCompletionContentPartImageParam": + OpenAIChatCompletionContentPartImageParam: type: object properties: type: type: string const: image_url default: image_url - description: >- - Must be "image_url" to identify this as image content + description: Must be "image_url" to identify this as image content image_url: $ref: '#/components/schemas/OpenAIImageURL' - description: >- - Image URL specification and processing details + description: Image URL specification and processing details additionalProperties: false required: - - type - - image_url - title: >- - OpenAIChatCompletionContentPartImageParam - description: >- - Image content part for OpenAI-compatible chat completion messages. + - type + - image_url + title: OpenAIChatCompletionContentPartImageParam + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - - $ref: '#/components/schemas/OpenAIFile' + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + - $ref: '#/components/schemas/OpenAIFile' discriminator: propertyName: type mapping: @@ -3532,44 +3213,38 @@ components: type: string const: text default: text - description: >- - Must be "text" to identify this as text content + description: Must be "text" to identify this as text content text: type: string description: The text content of the message additionalProperties: false required: - - type - - text + - type + - text title: OpenAIChatCompletionContentPartTextParam - description: >- - Text content part for OpenAI-compatible chat completion messages. + description: Text content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionToolCall: type: object properties: index: type: integer - description: >- - (Optional) Index of the tool call in the list + description: (Optional) Index of the tool call in the list id: type: string - description: >- - (Optional) Unique identifier for the tool call + description: (Optional) Unique identifier for the tool call type: type: string const: function default: function - description: >- - Must be "function" to identify this as a function call + description: Must be "function" to identify this as a function call function: $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' description: (Optional) Function call details additionalProperties: false required: - - type + - type title: OpenAIChatCompletionToolCall - description: >- - Tool call specification for OpenAI-compatible chat completion responses. + description: Tool call specification for OpenAI-compatible chat completion responses. OpenAIChatCompletionToolCallFunction: type: object properties: @@ -3578,12 +3253,10 @@ components: description: (Optional) Name of the function to call arguments: type: string - description: >- - (Optional) Arguments to pass to the function as a JSON string + description: (Optional) Arguments to pass to the function as a JSON string additionalProperties: false title: OpenAIChatCompletionToolCallFunction - description: >- - Function call details for OpenAI-compatible tool calls. + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: type: object properties: @@ -3603,40 +3276,34 @@ components: type: integer description: Number of tokens retrieved from cache additionalProperties: false - title: >- - OpenAIChatCompletionUsagePromptTokensDetails - description: >- - Token details for prompt tokens in OpenAI chat completion usage. + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. completion_tokens_details: type: object properties: reasoning_tokens: type: integer - description: >- - Number of tokens used for reasoning (o1/o3 models) + description: Number of tokens used for reasoning (o1/o3 models) additionalProperties: false - title: >- - OpenAIChatCompletionUsageCompletionTokensDetails - description: >- - Token details for output tokens in OpenAI chat completion usage. + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. additionalProperties: false required: - - prompt_tokens - - completion_tokens - - total_tokens + - prompt_tokens + - completion_tokens + - total_tokens title: OpenAIChatCompletionUsage - description: >- - Usage information for OpenAI chat completion. + description: Usage information for OpenAI chat completion. OpenAIChoice: type: object properties: message: oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - - $ref: '#/components/schemas/OpenAISystemMessageParam' - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - - $ref: '#/components/schemas/OpenAIToolMessageParam' - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + - $ref: '#/components/schemas/OpenAIUserMessageParam' + - $ref: '#/components/schemas/OpenAISystemMessageParam' + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + - $ref: '#/components/schemas/OpenAIToolMessageParam' + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' discriminator: propertyName: role mapping: @@ -3654,16 +3321,14 @@ components: description: The index of the choice logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message additionalProperties: false required: - - message - - finish_reason - - index + - message + - finish_reason + - index title: OpenAIChoice - description: >- - A choice from an OpenAI-compatible chat completion response. + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: type: object properties: @@ -3671,18 +3336,15 @@ components: type: array items: $ref: '#/components/schemas/OpenAITokenLogProb' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message refusal: type: array items: $ref: '#/components/schemas/OpenAITokenLogProb' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message additionalProperties: false title: OpenAIChoiceLogprobs - description: >- - The log probabilities for the tokens in the message from an OpenAI-compatible + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: type: object @@ -3691,26 +3353,24 @@ components: type: string const: developer default: developer - description: >- - Must be "developer" to identify this as a developer message + description: Must be "developer" to identify this as a developer message content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The content of the developer message name: type: string - description: >- - (Optional) The name of the developer message participant. + description: (Optional) The name of the developer message participant. additionalProperties: false required: - - role - - content + - role + - content title: OpenAIDeveloperMessageParam - description: >- - A message from the developer in an OpenAI-compatible chat completion request. + description: A message from the developer in an OpenAI-compatible chat completion + request. OpenAIFile: type: object properties: @@ -3722,8 +3382,8 @@ components: $ref: '#/components/schemas/OpenAIFileFile' additionalProperties: false required: - - type - - file + - type + - file title: OpenAIFile OpenAIFileFile: type: object @@ -3741,26 +3401,23 @@ components: properties: url: type: string - description: >- - URL of the image to include in the message + description: URL of the image to include in the message detail: type: string - description: >- - (Optional) Level of detail for image processing. Can be "low", "high", - or "auto" + description: (Optional) Level of detail for image processing. Can be "low", + "high", or "auto" additionalProperties: false required: - - url + - url title: OpenAIImageURL - description: >- - Image URL specification for OpenAI-compatible chat completion messages. + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - - $ref: '#/components/schemas/OpenAISystemMessageParam' - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - - $ref: '#/components/schemas/OpenAIToolMessageParam' - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + - $ref: '#/components/schemas/OpenAIUserMessageParam' + - $ref: '#/components/schemas/OpenAISystemMessageParam' + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + - $ref: '#/components/schemas/OpenAIToolMessageParam' + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' discriminator: propertyName: role mapping: @@ -3776,29 +3433,25 @@ components: type: string const: system default: system - description: >- - Must be "system" to identify this as a system message + description: Must be "system" to identify this as a system message content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - description: >- - The content of the "system prompt". If multiple system messages are provided, - they are concatenated. The underlying Llama Stack code may also add other - system messages (for example, for formatting tool definitions). + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + description: The content of the "system prompt". If multiple system messages + are provided, they are concatenated. The underlying Llama Stack code may + also add other system messages (for example, for formatting tool definitions). name: type: string - description: >- - (Optional) The name of the system message participant. + description: (Optional) The name of the system message participant. additionalProperties: false required: - - role - - content + - role + - content title: OpenAISystemMessageParam - description: >- - A system message providing instructions or context to the model. + description: A system message providing instructions or context to the model. OpenAITokenLogProb: type: object properties: @@ -3816,13 +3469,12 @@ components: $ref: '#/components/schemas/OpenAITopLogProb' additionalProperties: false required: - - token - - logprob - - top_logprobs + - token + - logprob + - top_logprobs title: OpenAITokenLogProb - description: >- - The log probability for a token from an OpenAI-compatible chat completion - response. + description: The log probability for a token from an OpenAI-compatible chat + completion response. OpenAIToolMessageParam: type: object properties: @@ -3830,27 +3482,24 @@ components: type: string const: tool default: tool - description: >- - Must be "tool" to identify this as a tool response + description: Must be "tool" to identify this as a tool response tool_call_id: type: string - description: >- - Unique identifier for the tool call this response is for + description: Unique identifier for the tool call this response is for content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The response content from the tool additionalProperties: false required: - - role - - tool_call_id - - content + - role + - tool_call_id + - content title: OpenAIToolMessageParam - description: >- - A message representing the result of a tool invocation in an OpenAI-compatible + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. OpenAITopLogProb: type: object @@ -3865,12 +3514,11 @@ components: type: number additionalProperties: false required: - - token - - logprob + - token + - logprob title: OpenAITopLogProb - description: >- - The top log probability for a token from an OpenAI-compatible chat completion - response. + description: The top log probability for a token from an OpenAI-compatible chat + completion response. OpenAIUserMessageParam: type: object properties: @@ -3878,27 +3526,25 @@ components: type: string const: user default: user - description: >- - Must be "user" to identify this as a user message + description: Must be "user" to identify this as a user message content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartParam' - description: >- - The content of the message, which can include text and other media + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartParam' + description: The content of the message, which can include text and other + media name: type: string - description: >- - (Optional) The name of the user message participant. + description: (Optional) The name of the user message participant. additionalProperties: false required: - - role - - content + - role + - content title: OpenAIUserMessageParam - description: >- - A message from the user in an OpenAI-compatible chat completion request. + description: A message from the user in an OpenAI-compatible chat completion + request. OpenAIJSONSchema: type: object properties: @@ -3910,25 +3556,24 @@ components: description: (Optional) Description of the schema strict: type: boolean - description: >- - (Optional) Whether to enforce strict adherence to the schema + description: (Optional) Whether to enforce strict adherence to the schema schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The JSON schema definition additionalProperties: false required: - - name + - name title: OpenAIJSONSchema - description: >- - JSON schema specification for OpenAI-compatible structured response format. + description: JSON schema specification for OpenAI-compatible structured response + format. OpenAIResponseFormatJSONObject: type: object properties: @@ -3936,14 +3581,14 @@ components: type: string const: json_object default: json_object - description: >- - Must be "json_object" to indicate generic JSON object response format + description: Must be "json_object" to indicate generic JSON object response + format additionalProperties: false required: - - type + - type title: OpenAIResponseFormatJSONObject - description: >- - JSON object response format for OpenAI-compatible chat completion requests. + description: JSON object response format for OpenAI-compatible chat completion + requests. OpenAIResponseFormatJSONSchema: type: object properties: @@ -3951,24 +3596,23 @@ components: type: string const: json_schema default: json_schema - description: >- - Must be "json_schema" to indicate structured JSON response format + description: Must be "json_schema" to indicate structured JSON response + format json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' - description: >- - The JSON schema specification for the response + description: The JSON schema specification for the response additionalProperties: false required: - - type - - json_schema + - type + - json_schema title: OpenAIResponseFormatJSONSchema - description: >- - JSON schema response format for OpenAI-compatible chat completion requests. + description: JSON schema response format for OpenAI-compatible chat completion + requests. OpenAIResponseFormatParam: oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + - $ref: '#/components/schemas/OpenAIResponseFormatText' + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' discriminator: propertyName: type mapping: @@ -3982,22 +3626,19 @@ components: type: string const: text default: text - description: >- - Must be "text" to indicate plain text response format + description: Must be "text" to indicate plain text response format additionalProperties: false required: - - type + - type title: OpenAIResponseFormatText - description: >- - Text response format for OpenAI-compatible chat completion requests. + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: type: object properties: model: type: string - description: >- - The identifier of the model to use. The model must be registered with - Llama Stack and available via the /models endpoint. + description: The identifier of the model to use. The model must be registered + with Llama Stack and available via the /models endpoint. messages: type: array items: @@ -4005,20 +3646,19 @@ components: description: List of messages in the conversation. frequency_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. function_call: oneOf: - - type: string - - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: string + - type: object + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The function call to use. functions: type: array @@ -4026,12 +3666,12 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) List of functions to use. logit_bias: type: object @@ -4043,24 +3683,19 @@ components: description: (Optional) The log probabilities to use. max_completion_tokens: type: integer - description: >- - (Optional) The maximum number of tokens to generate. + description: (Optional) The maximum number of tokens to generate. max_tokens: type: integer - description: >- - (Optional) The maximum number of tokens to generate. + description: (Optional) The maximum number of tokens to generate. n: type: integer - description: >- - (Optional) The number of completions to generate. + description: (Optional) The number of completions to generate. parallel_tool_calls: type: boolean - description: >- - (Optional) Whether to parallelize tool calls. + description: (Optional) Whether to parallelize tool calls. presence_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. response_format: $ref: '#/components/schemas/OpenAIResponseFormatParam' description: (Optional) The response format to use. @@ -4069,41 +3704,40 @@ components: description: (Optional) The seed to use. stop: oneOf: - - type: string - - type: array - items: - type: string + - type: string + - type: array + items: + type: string description: (Optional) The stop tokens to use. stream: type: boolean - description: >- - (Optional) Whether to stream the response. + description: (Optional) Whether to stream the response. stream_options: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The stream options to use. temperature: type: number description: (Optional) The temperature to use. tool_choice: oneOf: - - type: string - - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: string + - type: object + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The tool choice to use. tools: type: array @@ -4111,17 +3745,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The tools to use. top_logprobs: type: integer - description: >- - (Optional) The top log probabilities to use. + description: (Optional) The top log probabilities to use. top_p: type: number description: (Optional) The top p to use. @@ -4130,11 +3763,10 @@ components: description: (Optional) The user to use. additionalProperties: false required: - - model - - messages + - model + - messages title: OpenAIChatCompletionRequestWithExtraBody - description: >- - Request parameters for OpenAI-compatible chat completion endpoint. + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: type: object properties: @@ -4150,30 +3782,26 @@ components: type: string const: chat.completion default: chat.completion - description: >- - The object type, which will be "chat.completion" + description: The object type, which will be "chat.completion" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion was + created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information for the completion + description: Token usage information for the completion additionalProperties: false required: - - id - - choices - - object - - created - - model + - id + - choices + - object + - created + - model title: OpenAIChatCompletion - description: >- - Response from an OpenAI-compatible chat completion request. + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: type: object properties: @@ -4189,30 +3817,28 @@ components: type: string const: chat.completion.chunk default: chat.completion.chunk - description: >- - The object type, which will be "chat.completion.chunk" + description: The object type, which will be "chat.completion.chunk" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion was + created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information (typically included in final chunk with stream_options) + description: Token usage information (typically included in final chunk + with stream_options) additionalProperties: false required: - - id - - choices - - object - - created - - model + - id + - choices + - object + - created + - model title: OpenAIChatCompletionChunk - description: >- - Chunk from a streaming response to an OpenAI-compatible chat completion request. + description: Chunk from a streaming response to an OpenAI-compatible chat completion + request. OpenAIChoiceDelta: type: object properties: @@ -4232,13 +3858,11 @@ components: description: (Optional) The tool calls of the delta reasoning_content: type: string - description: >- - (Optional) The reasoning content from the model (non-standard, for o1/o3 - models) + description: (Optional) The reasoning content from the model (non-standard, + for o1/o3 models) additionalProperties: false title: OpenAIChoiceDelta - description: >- - A delta from an OpenAI-compatible chat completion streaming response. + description: A delta from an OpenAI-compatible chat completion streaming response. OpenAIChunkChoice: type: object properties: @@ -4253,16 +3877,15 @@ components: description: The index of the choice logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message additionalProperties: false required: - - delta - - finish_reason - - index + - delta + - finish_reason + - index title: OpenAIChunkChoice - description: >- - A chunk choice from an OpenAI-compatible chat completion streaming response. + description: A chunk choice from an OpenAI-compatible chat completion streaming + response. OpenAICompletionWithInputMessages: type: object properties: @@ -4278,67 +3901,61 @@ components: type: string const: chat.completion default: chat.completion - description: >- - The object type, which will be "chat.completion" + description: The object type, which will be "chat.completion" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion was + created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information for the completion + description: Token usage information for the completion input_messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' additionalProperties: false required: - - id - - choices - - object - - created - - model - - input_messages + - id + - choices + - object + - created + - model + - input_messages title: OpenAICompletionWithInputMessages OpenAICompletionRequestWithExtraBody: type: object properties: model: type: string - description: >- - The identifier of the model to use. The model must be registered with - Llama Stack and available via the /models endpoint. + description: The identifier of the model to use. The model must be registered + with Llama Stack and available via the /models endpoint. prompt: oneOf: - - type: string - - type: array - items: - type: string - - type: array + - type: string + - type: array + items: + type: string + - type: array + items: + type: integer + - type: array + items: + type: array items: type: integer - - type: array - items: - type: array - items: - type: integer description: The prompt to generate a completion for. best_of: type: integer - description: >- - (Optional) The number of completions to generate. + description: (Optional) The number of completions to generate. echo: type: boolean description: (Optional) Whether to echo the prompt. frequency_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. logit_bias: type: object additionalProperties: @@ -4349,40 +3966,36 @@ components: description: (Optional) The log probabilities to use. max_tokens: type: integer - description: >- - (Optional) The maximum number of tokens to generate. + description: (Optional) The maximum number of tokens to generate. n: type: integer - description: >- - (Optional) The number of completions to generate. + description: (Optional) The number of completions to generate. presence_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. seed: type: integer description: (Optional) The seed to use. stop: oneOf: - - type: string - - type: array - items: - type: string + - type: string + - type: array + items: + type: string description: (Optional) The stop tokens to use. stream: type: boolean - description: >- - (Optional) Whether to stream the response. + description: (Optional) Whether to stream the response. stream_options: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The stream options to use. temperature: type: number @@ -4395,15 +4008,13 @@ components: description: (Optional) The user to use. suffix: type: string - description: >- - (Optional) The suffix that should be appended to the completion. + description: (Optional) The suffix that should be appended to the completion. additionalProperties: false required: - - model - - prompt + - model + - prompt title: OpenAICompletionRequestWithExtraBody - description: >- - Request parameters for OpenAI-compatible completion endpoint. + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: type: object properties: @@ -4423,14 +4034,13 @@ components: default: text_completion additionalProperties: false required: - - id - - choices - - created - - model - - object + - id + - choices + - created + - model + - object title: OpenAICompletion - description: >- - Response from an OpenAI-compatible completion request. + description: Response from an OpenAI-compatible completion request. OpenAICompletionChoice: type: object properties: @@ -4444,23 +4054,22 @@ components: $ref: '#/components/schemas/OpenAIChoiceLogprobs' additionalProperties: false required: - - finish_reason - - text - - index + - finish_reason + - text + - index title: OpenAICompletionChoice - description: >- - A choice from an OpenAI-compatible completion response. + description: A choice from an OpenAI-compatible completion response. ConversationItem: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' discriminator: propertyName: type mapping: @@ -4480,16 +4089,13 @@ components: type: string const: url_citation default: url_citation - description: >- - Annotation type identifier, always "url_citation" + description: Annotation type identifier, always "url_citation" end_index: type: integer - description: >- - End position of the citation span in the content + description: End position of the citation span in the content start_index: type: integer - description: >- - Start position of the citation span in the content + description: Start position of the citation span in the content title: type: string description: Title of the referenced web resource @@ -4498,15 +4104,14 @@ components: description: URL of the referenced web resource additionalProperties: false required: - - type - - end_index - - start_index - - title - - url + - type + - end_index + - start_index + - title + - url title: OpenAIResponseAnnotationCitation - description: >- - URL citation annotation for referencing external web resources. - "OpenAIResponseAnnotationContainerFileCitation": + description: URL citation annotation for referencing external web resources. + OpenAIResponseAnnotationContainerFileCitation: type: object properties: type: @@ -4525,14 +4130,13 @@ components: type: integer additionalProperties: false required: - - type - - container_id - - end_index - - file_id - - filename - - start_index - title: >- - OpenAIResponseAnnotationContainerFileCitation + - type + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation OpenAIResponseAnnotationFileCitation: type: object properties: @@ -4540,8 +4144,7 @@ components: type: string const: file_citation default: file_citation - description: >- - Annotation type identifier, always "file_citation" + description: Annotation type identifier, always "file_citation" file_id: type: string description: Unique identifier of the referenced file @@ -4550,17 +4153,16 @@ components: description: Name of the referenced file index: type: integer - description: >- - Position index of the citation within the content + description: Position index of the citation within the content additionalProperties: false required: - - type - - file_id - - filename - - index + - type + - file_id + - filename + - index title: OpenAIResponseAnnotationFileCitation - description: >- - File citation annotation for referencing specific files in response content. + description: File citation annotation for referencing specific files in response + content. OpenAIResponseAnnotationFilePath: type: object properties: @@ -4574,16 +4176,16 @@ components: type: integer additionalProperties: false required: - - type - - file_id - - index + - type + - file_id + - index title: OpenAIResponseAnnotationFilePath OpenAIResponseAnnotations: oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' discriminator: propertyName: type mapping: @@ -4598,19 +4200,17 @@ components: type: string const: refusal default: refusal - description: >- - Content part type identifier, always "refusal" + description: Content part type identifier, always "refusal" refusal: type: string description: Refusal text supplied by the model additionalProperties: false required: - - type - - refusal + - type + - refusal title: OpenAIResponseContentPartRefusal - description: >- - Refusal content within a streamed response part. - "OpenAIResponseInputFunctionToolCallOutput": + description: Refusal content within a streamed response part. + OpenAIResponseInputFunctionToolCallOutput: type: object properties: call_id: @@ -4627,19 +4227,17 @@ components: type: string additionalProperties: false required: - - call_id - - output - - type - title: >- - OpenAIResponseInputFunctionToolCallOutput - description: >- - This represents the output of a function call that gets passed back to the - model. + - call_id + - output + - type + title: OpenAIResponseInputFunctionToolCallOutput + description: This represents the output of a function call that gets passed + back to the model. OpenAIResponseInputMessageContent: oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' discriminator: propertyName: type mapping: @@ -4653,64 +4251,55 @@ components: type: string const: input_file default: input_file - description: >- - The type of the input item. Always `input_file`. + description: The type of the input item. Always `input_file`. file_data: type: string - description: >- - The data of the file to be sent to the model. + description: The data of the file to be sent to the model. file_id: type: string - description: >- - (Optional) The ID of the file to be sent to the model. + description: (Optional) The ID of the file to be sent to the model. file_url: type: string - description: >- - The URL of the file to be sent to the model. + description: The URL of the file to be sent to the model. filename: type: string - description: >- - The name of the file to be sent to the model. + description: The name of the file to be sent to the model. additionalProperties: false required: - - type + - type title: OpenAIResponseInputMessageContentFile - description: >- - File content for input messages in OpenAI response format. + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: type: object properties: detail: oneOf: - - type: string - const: low - - type: string - const: high - - type: string - const: auto + - type: string + const: low + - type: string + const: high + - type: string + const: auto default: auto - description: >- - Level of detail for image processing, can be "low", "high", or "auto" + description: Level of detail for image processing, can be "low", "high", + or "auto" type: type: string const: input_image default: input_image - description: >- - Content type identifier, always "input_image" + description: Content type identifier, always "input_image" file_id: type: string - description: >- - (Optional) The ID of the file to be sent to the model. + description: (Optional) The ID of the file to be sent to the model. image_url: type: string description: (Optional) URL of the image content additionalProperties: false required: - - detail - - type + - detail + - type title: OpenAIResponseInputMessageContentImage - description: >- - Image content for input messages in OpenAI response format. + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: type: object properties: @@ -4721,15 +4310,13 @@ components: type: string const: input_text default: input_text - description: >- - Content type identifier, always "input_text" + description: Content type identifier, always "input_text" additionalProperties: false required: - - text - - type + - text + - type title: OpenAIResponseInputMessageContentText - description: >- - Text content for input messages in OpenAI response format. + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: type: object properties: @@ -4747,14 +4334,13 @@ components: default: mcp_approval_request additionalProperties: false required: - - arguments - - id - - name - - server_label - - type + - arguments + - id + - name + - server_label + - type title: OpenAIResponseMCPApprovalRequest - description: >- - A request for human approval of a tool invocation. + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: type: object properties: @@ -4772,9 +4358,9 @@ components: type: string additionalProperties: false required: - - approval_request_id - - approve - - type + - approval_request_id + - approve + - type title: OpenAIResponseMCPApprovalResponse description: A response to an MCP approval request. OpenAIResponseMessage: @@ -4782,23 +4368,23 @@ components: properties: content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIResponseInputMessageContent' - - type: array - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContent' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIResponseInputMessageContent' + - type: array + items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageContent' role: oneOf: - - type: string - const: system - - type: string - const: developer - - type: string - const: user - - type: string - const: assistant + - type: string + const: system + - type: string + const: developer + - type: string + const: user + - type: string + const: assistant type: type: string const: message @@ -4809,24 +4395,23 @@ components: type: string additionalProperties: false required: - - content - - role - - type + - content + - role + - type 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. + 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. OpenAIResponseOutputMessageContent: oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - "OpenAIResponseOutputMessageContentOutputText": + OpenAIResponseOutputMessageContentOutputText: type: object properties: text: @@ -4841,12 +4426,11 @@ components: $ref: '#/components/schemas/OpenAIResponseAnnotations' additionalProperties: false required: - - text - - type - - annotations - title: >- - OpenAIResponseOutputMessageContentOutputText - "OpenAIResponseOutputMessageFileSearchToolCall": + - text + - type + - annotations + title: OpenAIResponseOutputMessageContentOutputText + OpenAIResponseOutputMessageFileSearchToolCall: type: object properties: id: @@ -4859,14 +4443,12 @@ components: description: List of search queries executed status: type: string - description: >- - Current status of the file search operation + description: Current status of the file search operation type: type: string const: file_search_call default: file_search_call - description: >- - Tool call type identifier, always "file_search_call" + description: Tool call type identifier, always "file_search_call" results: type: array items: @@ -4876,52 +4458,45 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Key-value attributes associated with the file + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Key-value attributes associated with the file file_id: type: string - description: >- - Unique identifier of the file containing the result + description: Unique identifier of the file containing the result filename: type: string description: Name of the file containing the result score: type: number - description: >- - Relevance score for this search result (between 0 and 1) + description: Relevance score for this search result (between 0 and + 1) text: type: string description: Text content of the search result additionalProperties: false required: - - attributes - - file_id - - filename - - score - - text - title: >- - OpenAIResponseOutputMessageFileSearchToolCallResults - description: >- - Search results returned by the file search operation. - description: >- - (Optional) Search results returned by the file search operation + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + description: (Optional) Search results returned by the file search operation additionalProperties: false required: - - id - - queries - - status - - type - title: >- - OpenAIResponseOutputMessageFileSearchToolCall - description: >- - File search tool call output message for OpenAI responses. - "OpenAIResponseOutputMessageFunctionToolCall": + - id + - queries + - status + - type + title: OpenAIResponseOutputMessageFileSearchToolCall + description: File search tool call output message for OpenAI responses. + OpenAIResponseOutputMessageFunctionToolCall: type: object properties: call_id: @@ -4932,32 +4507,26 @@ components: description: Name of the function being called arguments: type: string - description: >- - JSON string containing the function arguments + description: JSON string containing the function arguments type: type: string const: function_call default: function_call - description: >- - Tool call type identifier, always "function_call" + description: Tool call type identifier, always "function_call" id: type: string - description: >- - (Optional) Additional identifier for the tool call + description: (Optional) Additional identifier for the tool call status: type: string - description: >- - (Optional) Current status of the function call execution + description: (Optional) Current status of the function call execution additionalProperties: false required: - - call_id - - name - - arguments - - type - title: >- - OpenAIResponseOutputMessageFunctionToolCall - description: >- - Function tool call output message for OpenAI responses. + - call_id + - name + - arguments + - type + title: OpenAIResponseOutputMessageFunctionToolCall + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: type: object properties: @@ -4968,54 +4537,45 @@ components: type: string const: mcp_call default: mcp_call - description: >- - Tool call type identifier, always "mcp_call" + description: Tool call type identifier, always "mcp_call" arguments: type: string - description: >- - JSON string containing the MCP call arguments + description: JSON string containing the MCP call arguments name: type: string description: Name of the MCP method being called server_label: type: string - description: >- - Label identifying the MCP server handling the call + description: Label identifying the MCP server handling the call error: type: string - description: >- - (Optional) Error message if the MCP call failed + description: (Optional) Error message if the MCP call failed output: type: string - description: >- - (Optional) Output result from the successful MCP call + description: (Optional) Output result from the successful MCP call additionalProperties: false required: - - id - - type - - arguments - - name - - server_label + - id + - type + - arguments + - name + - server_label title: OpenAIResponseOutputMessageMCPCall - description: >- - Model Context Protocol (MCP) call output message for OpenAI responses. + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: type: object properties: id: type: string - description: >- - Unique identifier for this MCP list tools operation + description: Unique identifier for this MCP list tools operation type: type: string const: mcp_list_tools default: mcp_list_tools - description: >- - Tool call type identifier, always "mcp_list_tools" + description: Tool call type identifier, always "mcp_list_tools" server_label: type: string - description: >- - Label identifying the MCP server providing the tools + description: Label identifying the MCP server providing the tools tools: type: array items: @@ -5025,40 +4585,36 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - JSON schema defining the tool's input parameters + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: JSON schema defining the tool's input parameters name: type: string description: Name of the tool description: type: string - description: >- - (Optional) Description of what the tool does + description: (Optional) Description of what the tool does additionalProperties: false required: - - input_schema - - name + - input_schema + - name title: MCPListToolsTool - description: >- - Tool definition returned by MCP list tools operation. - description: >- - List of available tools provided by the MCP server + description: Tool definition returned by MCP list tools operation. + description: List of available tools provided by the MCP server additionalProperties: false required: - - id - - type - - server_label - - tools + - id + - type + - server_label + - tools title: OpenAIResponseOutputMessageMCPListTools - description: >- - MCP list tools output message containing available tools from an MCP server. - "OpenAIResponseOutputMessageWebSearchToolCall": + description: MCP list tools output message containing available tools from an + MCP server. + OpenAIResponseOutputMessageWebSearchToolCall: type: object properties: id: @@ -5066,23 +4622,19 @@ components: description: Unique identifier for this tool call status: type: string - description: >- - Current status of the web search operation + description: Current status of the web search operation type: type: string const: web_search_call default: web_search_call - description: >- - Tool call type identifier, always "web_search_call" + description: Tool call type identifier, always "web_search_call" additionalProperties: false required: - - id - - status - - type - title: >- - OpenAIResponseOutputMessageWebSearchToolCall - description: >- - Web search tool call output message for OpenAI responses. + - id + - status + - type + title: OpenAIResponseOutputMessageWebSearchToolCall + description: Web search tool call output message for OpenAI responses. CreateConversationRequest: type: object properties: @@ -5090,14 +4642,12 @@ components: type: array items: $ref: '#/components/schemas/ConversationItem' - description: >- - Initial items to include in the conversation context. + description: Initial items to include in the conversation context. metadata: type: object additionalProperties: type: string - description: >- - Set of key-value pairs that can be attached to an object. + description: Set of key-value pairs that can be attached to an object. additionalProperties: false title: CreateConversationRequest Conversation: @@ -5120,17 +4670,17 @@ components: items: type: object title: dict - description: >- - dict() -> new empty dictionary dict(mapping) -> new dictionary initialized - from a mapping object's (key, value) pairs dict(iterable) -> new - dictionary initialized as if via: d = {} for k, v in iterable: d[k] - = v dict(**kwargs) -> new dictionary initialized with the name=value - pairs in the keyword argument list. For example: dict(one=1, two=2) + description: 'dict() -> new empty dictionary dict(mapping) -> new dictionary + initialized from a mapping object''s (key, value) pairs dict(iterable) + -> new dictionary initialized as if via: d = {} for k, v in + iterable: d[k] = v dict(**kwargs) -> new dictionary initialized + with the name=value pairs in the keyword argument list. For example: dict(one=1, + two=2)' additionalProperties: false required: - - id - - object - - created_at + - id + - object + - created_at title: Conversation description: OpenAI-compatible conversation object. UpdateConversationRequest: @@ -5140,11 +4690,10 @@ components: type: object additionalProperties: type: string - description: >- - Set of key-value pairs that can be attached to an object. + description: Set of key-value pairs that can be attached to an object. additionalProperties: false required: - - metadata + - metadata title: UpdateConversationRequest ConversationDeletedResource: type: object @@ -5159,9 +4708,9 @@ components: default: true additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: ConversationDeletedResource description: Response for deleted conversation. ConversationItemList: @@ -5183,12 +4732,11 @@ components: default: false additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: ConversationItemList - description: >- - List of conversation items with pagination. + description: List of conversation items with pagination. AddItemsRequest: type: object properties: @@ -5196,11 +4744,10 @@ components: type: array items: $ref: '#/components/schemas/ConversationItem' - description: >- - Items to include in the conversation context. + description: Items to include in the conversation context. additionalProperties: false required: - - items + - items title: AddItemsRequest ConversationItemDeletedResource: type: object @@ -5215,9 +4762,9 @@ components: default: true additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: ConversationItemDeletedResource description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: @@ -5225,41 +4772,35 @@ components: properties: model: type: string - description: >- - The identifier of the model to use. The model must be an embedding model - registered with Llama Stack and available via the /models endpoint. + description: The identifier of the model to use. The model must be an embedding + model registered with Llama Stack and available via the /models endpoint. input: oneOf: - - type: string - - type: array - items: - type: string - description: >- - Input text to embed, encoded as a string or array of strings. To embed - multiple inputs in a single request, pass an array of strings. + - type: string + - type: array + items: + type: string + description: Input text to embed, encoded as a string or array of strings. + To embed multiple inputs in a single request, pass an array of strings. encoding_format: type: string default: float - description: >- - (Optional) The format to return the embeddings in. Can be either "float" - or "base64". Defaults to "float". + description: (Optional) The format to return the embeddings in. Can be either + "float" or "base64". Defaults to "float". dimensions: type: integer - description: >- - (Optional) The number of dimensions the resulting output embeddings should - have. Only supported in text-embedding-3 and later models. + description: (Optional) The number of dimensions the resulting output embeddings + should have. Only supported in text-embedding-3 and later models. user: type: string - description: >- - (Optional) A unique identifier representing your end-user, which can help - OpenAI to monitor and detect abuse. + description: (Optional) A unique identifier representing your end-user, + which can help OpenAI to monitor and detect abuse. additionalProperties: false required: - - model - - input + - model + - input title: OpenAIEmbeddingsRequestWithExtraBody - description: >- - Request parameters for OpenAI-compatible embeddings endpoint. + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: type: object properties: @@ -5267,29 +4808,26 @@ components: type: string const: embedding default: embedding - description: >- - The object type, which will be "embedding" + description: The object type, which will be "embedding" embedding: oneOf: - - type: array - items: - type: number - - type: string - description: >- - The embedding vector as a list of floats (when encoding_format="float") + - type: array + items: + type: number + - type: string + description: The embedding vector as a list of floats (when encoding_format="float") or as a base64-encoded string (when encoding_format="base64") index: type: integer - description: >- - The index of the embedding in the input list + description: The index of the embedding in the input list additionalProperties: false required: - - object - - embedding - - index + - object + - embedding + - index title: OpenAIEmbeddingData - description: >- - A single embedding data object from an OpenAI-compatible embeddings response. + description: A single embedding data object from an OpenAI-compatible embeddings + response. OpenAIEmbeddingUsage: type: object properties: @@ -5301,11 +4839,10 @@ components: description: The total number of tokens used additionalProperties: false required: - - prompt_tokens - - total_tokens + - prompt_tokens + - total_tokens title: OpenAIEmbeddingUsage - description: >- - Usage information for an OpenAI-compatible embeddings response. + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: type: object properties: @@ -5321,28 +4858,25 @@ components: description: List of embedding data objects model: type: string - description: >- - The model that was used to generate the embeddings + description: The model that was used to generate the embeddings usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' description: Usage information additionalProperties: false required: - - object - - data - - model - - usage + - object + - data + - model + - usage title: OpenAIEmbeddingsResponse - description: >- - Response from an OpenAI-compatible embeddings request. + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: type: string enum: - - assistants - - batch + - assistants + - batch title: OpenAIFilePurpose - description: >- - Valid purpose values for OpenAI Files API. + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: type: object properties: @@ -5353,16 +4887,13 @@ components: description: List of file objects has_more: type: boolean - description: >- - Whether there are more files available beyond this page + description: Whether there are more files available beyond this page first_id: type: string - description: >- - ID of the first file in the list for pagination + description: ID of the first file in the list for pagination last_id: type: string - description: >- - ID of the last file in the list for pagination + description: ID of the last file in the list for pagination object: type: string const: list @@ -5370,14 +4901,13 @@ components: description: The object type, which is always "list" additionalProperties: false required: - - data - - has_more - - first_id - - last_id - - object + - data + - has_more + - first_id + - last_id + - object title: ListOpenAIFileResponse - description: >- - Response for listing files in OpenAI Files API. + description: Response for listing files in OpenAI Files API. OpenAIFileObject: type: object properties: @@ -5388,40 +4918,36 @@ components: description: The object type, which is always "file" id: type: string - description: >- - The file identifier, which can be referenced in the API endpoints + description: The file identifier, which can be referenced in the API endpoints bytes: type: integer description: The size of the file, in bytes created_at: type: integer - description: >- - The Unix timestamp (in seconds) for when the file was created + description: The Unix timestamp (in seconds) for when the file was created expires_at: type: integer - description: >- - The Unix timestamp (in seconds) for when the file expires + description: The Unix timestamp (in seconds) for when the file expires filename: type: string description: The name of the file purpose: type: string enum: - - assistants - - batch + - assistants + - batch description: The intended purpose of the file additionalProperties: false required: - - object - - id - - bytes - - created_at - - expires_at - - filename - - purpose + - object + - id + - bytes + - created_at + - expires_at + - filename + - purpose title: OpenAIFileObject - description: >- - OpenAI File object as defined in the OpenAI Files API. + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: type: object properties: @@ -5432,15 +4958,12 @@ components: type: integer additionalProperties: false required: - - anchor - - seconds + - 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) + description: "Control expiration of uploaded files.\nParams:\n - anchor, must\ + \ be \"created_at\"\n - seconds, must be int between 3600 and 2592000 (1 hour\ + \ to 30 days)" OpenAIFileDeleteResponse: type: object properties: @@ -5454,16 +4977,14 @@ components: description: The object type, which is always "file" deleted: type: boolean - description: >- - Whether the file was successfully deleted + description: Whether the file was successfully deleted additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: OpenAIFileDeleteResponse - description: >- - Response for deleting a file in OpenAI Files API. + description: Response for deleting a file in OpenAI Files API. Response: type: object title: Response @@ -5473,16 +4994,15 @@ components: status: type: string enum: - - OK - - Error - - Not Implemented + - OK + - Error + - Not Implemented description: Current health status of the service additionalProperties: false required: - - status + - status title: HealthInfo - description: >- - Health status information for the service. + description: Health status information for the service. RouteInfo: type: object properties: @@ -5496,17 +5016,15 @@ components: type: array items: type: string - description: >- - List of provider types that implement this route + description: List of provider types that implement this route additionalProperties: false required: - - route - - method - - provider_types + - route + - method + - provider_types title: RouteInfo - description: >- - Information about an API route including its path, method, and implementing - providers. + description: Information about an API route including its path, method, and + implementing providers. ListRoutesResponse: type: object properties: @@ -5514,14 +5032,12 @@ components: type: array items: $ref: '#/components/schemas/RouteInfo' - description: >- - List of available route information objects + description: List of available route information objects additionalProperties: false required: - - data + - data title: ListRoutesResponse - description: >- - Response containing a list of all available API routes. + description: Response containing a list of all available API routes. OpenAIModel: type: object properties: @@ -5539,18 +5055,18 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object additionalProperties: false required: - - id - - object - - created - - owned_by + - id + - object + - created + - owned_by title: OpenAIModel description: A model from OpenAI. OpenAIListModelsResponse: @@ -5562,17 +5078,16 @@ components: $ref: '#/components/schemas/OpenAIModel' additionalProperties: false required: - - data + - data title: OpenAIListModelsResponse ModelType: type: string enum: - - llm - - embedding - - rerank + - llm + - embedding + - rerank title: ModelType - description: >- - Enumeration of supported model types in Llama Stack. + description: Enumeration of supported model types in Llama Stack. RegisterModelRequest: type: object properties: @@ -5581,8 +5096,7 @@ components: description: The identifier of the model to register. provider_model_id: type: string - description: >- - The identifier of the model in the provider. + description: The identifier of the model in the provider. provider_id: type: string description: The identifier of the provider. @@ -5590,108 +5104,99 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Any additional metadata for this model. model_type: $ref: '#/components/schemas/ModelType' description: The type of model to register. additionalProperties: false required: - - model_id + - model_id title: RegisterModelRequest Model: type: object properties: identifier: type: string - description: >- - Unique identifier for this resource in llama stack + description: Unique identifier for this resource in llama stack provider_resource_id: type: string - description: >- - Unique identifier for this resource in the provider + description: Unique identifier for this resource in the provider provider_id: type: string - description: >- - ID of the provider that owns this resource + description: ID of the provider that owns this resource type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: model default: model - description: >- - The resource type, always 'model' for model resources + description: The resource type, always 'model' for model resources metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm - description: >- - The type of model (LLM or embedding model) + description: The type of model (LLM or embedding model) additionalProperties: false required: - - identifier - - provider_id - - type - - metadata - - model_type + - identifier + - provider_id + - type + - metadata + - model_type title: Model - description: >- - A model resource representing an AI model registered in Llama Stack. + description: A model resource representing an AI model registered in Llama Stack. RunModerationRequest: type: object properties: input: oneOf: - - type: string - - type: array - items: - type: string - description: >- - Input (or inputs) to classify. Can be a single string, an array of strings, - or an array of multi-modal input objects similar to other models. + - type: string + - type: array + items: + type: string + description: Input (or inputs) to classify. Can be a single string, an array + of strings, or an array of multi-modal input objects similar to other + models. model: type: string - description: >- - (Optional) The content moderation model you would like to use. + description: (Optional) The content moderation model you would like to use. additionalProperties: false required: - - input + - input title: RunModerationRequest ModerationObject: type: object properties: id: type: string - description: >- - The unique identifier for the moderation request. + description: The unique identifier for the moderation request. model: type: string - description: >- - The model used to generate the moderation results. + description: The model used to generate the moderation results. results: type: array items: @@ -5699,9 +5204,9 @@ components: description: A list of moderation objects additionalProperties: false required: - - id - - model - - results + - id + - model + - results title: ModerationObject description: A moderation object. ModerationObjectResults: @@ -5709,45 +5214,42 @@ components: properties: flagged: type: boolean - description: >- - Whether any of the below categories are flagged. + description: Whether any of the below categories are flagged. categories: type: object additionalProperties: type: boolean - description: >- - A list of the categories, and whether they are flagged or not. + description: A list of the categories, and whether they are flagged or not. category_applied_input_types: type: object additionalProperties: type: array items: type: string - description: >- - A list of the categories along with the input type(s) that the score applies - to. + description: A list of the categories along with the input type(s) that + the score applies to. category_scores: type: object additionalProperties: type: number - description: >- - A list of the categories along with their scores as predicted by model. + description: A list of the categories along with their scores as predicted + by model. user_message: type: string metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object additionalProperties: false required: - - flagged - - metadata + - flagged + - metadata title: ModerationObjectResults description: A moderation object. Prompt: @@ -5755,39 +5257,34 @@ components: properties: prompt: type: string - description: >- - The system prompt text with variable placeholders. Variables are only - supported when using the Responses API. + description: The system prompt text with variable placeholders. Variables + are only supported when using the Responses API. version: type: integer - description: >- - Version (integer starting at 1, incremented on save) + description: Version (integer starting at 1, incremented on save) prompt_id: type: string - description: >- - Unique identifier formatted as 'pmpt_<48-digit-hash>' + description: Unique identifier formatted as 'pmpt_<48-digit-hash>' variables: type: array items: type: string - description: >- - List of prompt variable names that can be used in the prompt template + description: List of prompt variable names that can be used in the prompt + template is_default: type: boolean default: false - description: >- - Boolean indicating whether this version is the default version for this - prompt + description: Boolean indicating whether this version is the default version + for this prompt additionalProperties: false required: - - version - - prompt_id - - variables - - is_default + - version + - prompt_id + - variables + - is_default title: Prompt - description: >- - A prompt resource representing a stored OpenAI Compatible prompt template - in Llama Stack. + description: A prompt resource representing a stored OpenAI Compatible prompt + template in Llama Stack. ListPromptsResponse: type: object properties: @@ -5797,7 +5294,7 @@ components: $ref: '#/components/schemas/Prompt' additionalProperties: false required: - - data + - data title: ListPromptsResponse description: Response model to list prompts. CreatePromptRequest: @@ -5805,17 +5302,15 @@ components: properties: prompt: type: string - description: >- - The prompt text content with variable placeholders. + description: The prompt text content with variable placeholders. variables: type: array items: type: string - description: >- - List of variable names that can be used in the prompt template. + description: List of variable names that can be used in the prompt template. additionalProperties: false required: - - prompt + - prompt title: CreatePromptRequest UpdatePromptRequest: type: object @@ -5825,23 +5320,21 @@ components: description: The updated prompt text content. version: type: integer - description: >- - The current version of the prompt being updated. + description: The current version of the prompt being updated. variables: type: array items: type: string - description: >- - Updated list of variable names that can be used in the prompt template. + description: Updated list of variable names that can be used in the prompt + template. set_as_default: type: boolean - description: >- - Set the new version as the default (default=True). + description: Set the new version as the default (default=True). additionalProperties: false required: - - prompt - - version - - set_as_default + - prompt + - version + - set_as_default title: UpdatePromptRequest SetDefaultVersionRequest: type: object @@ -5851,7 +5344,7 @@ components: description: The version to set as default. additionalProperties: false required: - - version + - version title: SetDefaultVersionRequest ProviderInfo: type: object @@ -5869,36 +5362,34 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Configuration parameters for the provider + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Configuration parameters for the provider health: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Current health status of the provider additionalProperties: false required: - - api - - provider_id - - provider_type - - config - - health + - api + - provider_id + - provider_type + - config + - health title: ProviderInfo - description: >- - Information about a registered provider including its configuration and health - status. + description: Information about a registered provider including its configuration + and health status. ListProvidersResponse: type: object properties: @@ -5909,10 +5400,9 @@ components: description: List of provider information objects additionalProperties: false required: - - data + - data title: ListProvidersResponse - description: >- - Response containing a list of all available providers. + description: Response containing a list of all available providers. ListOpenAIResponseObject: type: object properties: @@ -5920,16 +5410,13 @@ components: type: array items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - description: >- - List of response objects with their input context + description: List of response objects with their input context has_more: type: boolean - description: >- - Whether there are more results available beyond this page + description: Whether there are more results available beyond this page first_id: type: string - description: >- - Identifier of the first item in this page + description: Identifier of the first item in this page last_id: type: string description: Identifier of the last item in this page @@ -5940,38 +5427,34 @@ components: description: Object type identifier, always "list" additionalProperties: false required: - - data - - has_more - - first_id - - last_id - - object + - data + - has_more + - first_id + - last_id + - object title: ListOpenAIResponseObject - description: >- - Paginated list of OpenAI response objects with navigation metadata. + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: type: object properties: code: type: string - description: >- - Error code identifying the type of failure + description: Error code identifying the type of failure message: type: string - description: >- - Human-readable error message describing the failure + description: Human-readable error message describing the failure additionalProperties: false required: - - code - - message + - code + - message title: OpenAIResponseError - description: >- - Error details for failed OpenAI response requests. + description: Error details for failed OpenAI response requests. OpenAIResponseInput: oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutput' - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutput' + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + - $ref: '#/components/schemas/OpenAIResponseMessage' OpenAIResponseInputToolFileSearch: type: object properties: @@ -5979,53 +5462,45 @@ components: type: string const: file_search default: file_search - description: >- - Tool type identifier, always "file_search" + description: Tool type identifier, always "file_search" vector_store_ids: type: array items: type: string - description: >- - List of vector store identifiers to search within + description: List of vector store identifiers to search within filters: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional filters to apply to the search + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional filters to apply to the search max_num_results: type: integer default: 10 - description: >- - (Optional) Maximum number of search results to return (1-50) + description: (Optional) Maximum number of search results to return (1-50) ranking_options: type: object properties: ranker: type: string - description: >- - (Optional) Name of the ranking algorithm to use + description: (Optional) Name of the ranking algorithm to use score_threshold: type: number default: 0.0 - description: >- - (Optional) Minimum relevance score threshold for results + description: (Optional) Minimum relevance score threshold for results additionalProperties: false - description: >- - (Optional) Options for ranking and scoring search results + description: (Optional) Options for ranking and scoring search results additionalProperties: false required: - - type - - vector_store_ids + - type + - vector_store_ids title: OpenAIResponseInputToolFileSearch - description: >- - File search tool configuration for OpenAI response inputs. + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: type: object properties: @@ -6039,66 +5514,59 @@ components: description: Name of the function that can be called description: type: string - description: >- - (Optional) Description of what the function does + description: (Optional) Description of what the function does parameters: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) JSON schema defining the function's parameters + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) JSON schema defining the function's parameters strict: type: boolean - description: >- - (Optional) Whether to enforce strict parameter validation + description: (Optional) Whether to enforce strict parameter validation additionalProperties: false required: - - type - - name + - type + - name title: OpenAIResponseInputToolFunction - description: >- - Function tool configuration for OpenAI response inputs. + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: type: object properties: type: oneOf: - - type: string - const: web_search - - type: string - const: web_search_preview - - type: string - const: web_search_preview_2025_03_11 + - type: string + const: web_search + - type: string + const: web_search_preview + - type: string + const: web_search_preview_2025_03_11 default: web_search description: Web search tool type variant to use search_context_size: type: string default: medium - description: >- - (Optional) Size of search context, must be "low", "medium", or "high" + description: (Optional) Size of search context, must be "low", "medium", + or "high" additionalProperties: false required: - - type + - type title: OpenAIResponseInputToolWebSearch - description: >- - Web search tool configuration for OpenAI response inputs. + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: type: object properties: created_at: type: integer - description: >- - Unix timestamp when the response was created + description: Unix timestamp when the response was created error: $ref: '#/components/schemas/OpenAIResponseError' - description: >- - (Optional) Error details if the response generation failed + description: (Optional) Error details if the response generation failed id: type: string description: Unique identifier for this response @@ -6109,90 +5577,76 @@ components: type: string const: response default: response - description: >- - Object type identifier, always "response" + description: Object type identifier, always "response" output: type: array items: $ref: '#/components/schemas/OpenAIResponseOutput' - description: >- - List of generated output items (messages, tool calls, etc.) + description: List of generated output items (messages, tool calls, etc.) parallel_tool_calls: type: boolean default: false - description: >- - Whether tool calls can be executed in parallel + description: Whether tool calls can be executed in parallel previous_response_id: type: string - description: >- - (Optional) ID of the previous response in a conversation + description: (Optional) ID of the previous response in a conversation prompt: $ref: '#/components/schemas/OpenAIResponsePrompt' - description: >- - (Optional) Reference to a prompt template and its variables. + description: (Optional) Reference to a prompt template and its variables. status: type: string - description: >- - Current status of the response generation + description: Current status of the response generation temperature: type: number - description: >- - (Optional) Sampling temperature used for generation + description: (Optional) Sampling temperature used for generation text: $ref: '#/components/schemas/OpenAIResponseText' - description: >- - Text formatting configuration for the response + description: Text formatting configuration for the response top_p: type: number - description: >- - (Optional) Nucleus sampling parameter used for generation + description: (Optional) Nucleus sampling parameter used for generation tools: type: array items: $ref: '#/components/schemas/OpenAIResponseTool' - description: >- - (Optional) An array of tools the model may call while generating a response. + description: (Optional) An array of tools the model may call while generating + a response. truncation: type: string - description: >- - (Optional) Truncation strategy applied to the response + description: (Optional) Truncation strategy applied to the response usage: $ref: '#/components/schemas/OpenAIResponseUsage' - description: >- - (Optional) Token usage information for the response + description: (Optional) Token usage information for the response instructions: type: string - description: >- - (Optional) System message inserted into the model's context + description: (Optional) System message inserted into the model's context input: type: array items: $ref: '#/components/schemas/OpenAIResponseInput' - description: >- - List of input items that led to this response + description: List of input items that led to this response additionalProperties: false required: - - created_at - - id - - model - - object - - output - - parallel_tool_calls - - status - - text - - input + - created_at + - id + - model + - object + - output + - parallel_tool_calls + - status + - text + - input title: OpenAIResponseObjectWithInput - description: >- - OpenAI response object extended with input context information. + description: OpenAI response object extended with input context information. OpenAIResponseOutput: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: @@ -6213,20 +5667,18 @@ components: type: object additionalProperties: $ref: '#/components/schemas/OpenAIResponseInputMessageContent' - description: >- - Dictionary of variable names to OpenAIResponseInputMessageContent structure - for template substitution. The substitution values can either be strings, - or other Response input types like images or files. + description: Dictionary of variable names to OpenAIResponseInputMessageContent + structure for template substitution. The substitution values can either + be strings, or other Response input types like images or files. version: type: string - description: >- - Version number of the prompt to use (defaults to latest if not specified) + description: Version number of the prompt to use (defaults to latest if + not specified) additionalProperties: false required: - - id + - id title: OpenAIResponsePrompt - description: >- - OpenAI compatible Prompt object that is used in OpenAI responses. + description: OpenAI compatible Prompt object that is used in OpenAI responses. OpenAIResponseText: type: object properties: @@ -6235,56 +5687,52 @@ components: properties: type: oneOf: - - type: string - const: text - - type: string - const: json_schema - - type: string - const: json_object - description: >- - Must be "text", "json_schema", or "json_object" to identify the format - type + - type: string + const: text + - type: string + const: json_schema + - type: string + const: json_object + description: Must be "text", "json_schema", or "json_object" to identify + the format type name: type: string - description: >- - The name of the response format. Only used for json_schema. + description: The name of the response format. Only used for json_schema. schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The JSON schema the response should conform to. In a Python SDK, this - is often a `pydantic` model. Only used for json_schema. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The JSON schema the response should conform to. In a Python + SDK, this is often a `pydantic` model. Only used for json_schema. description: type: string - description: >- - (Optional) A description of the response format. Only used for json_schema. + description: (Optional) A description of the response format. Only used + for json_schema. strict: type: boolean - description: >- - (Optional) Whether to strictly enforce the JSON schema. If true, the - response must match the schema exactly. Only used for json_schema. + description: (Optional) Whether to strictly enforce the JSON schema. + If true, the response must match the schema exactly. Only used for + json_schema. additionalProperties: false required: - - type - description: >- - (Optional) Text format configuration specifying output format requirements + - type + description: (Optional) Text format configuration specifying output format + requirements additionalProperties: false title: OpenAIResponseText - description: >- - Text response configuration for OpenAI responses. + description: Text response configuration for OpenAI responses. OpenAIResponseTool: oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - - $ref: '#/components/schemas/OpenAIResponseToolMCP' + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + - $ref: '#/components/schemas/OpenAIResponseToolMCP' discriminator: propertyName: type mapping: @@ -6305,30 +5753,29 @@ components: description: Label to identify this MCP server allowed_tools: oneOf: - - type: array - items: - type: string - - type: object - properties: - tool_names: - type: array - items: - type: string - description: >- - (Optional) List of specific tool names that are allowed - additionalProperties: false - title: AllowedToolsFilter - description: >- - Filter configuration for restricting which MCP tools can be used. - description: >- - (Optional) Restriction on which tools can be used from this server + - type: array + items: + type: string + - type: object + properties: + tool_names: + type: array + items: + type: string + description: (Optional) List of specific tool names that are allowed + additionalProperties: false + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can + be used. + description: (Optional) Restriction on which tools can be used from this + server additionalProperties: false required: - - type - - server_label + - type + - server_label title: OpenAIResponseToolMCP - description: >- - Model Context Protocol (MCP) tool configuration for OpenAI response object. + description: Model Context Protocol (MCP) tool configuration for OpenAI response + object. OpenAIResponseUsage: type: object properties: @@ -6354,15 +5801,14 @@ components: properties: reasoning_tokens: type: integer - description: >- - Number of tokens used for reasoning (o1/o3 models) + description: Number of tokens used for reasoning (o1/o3 models) additionalProperties: false description: Detailed breakdown of output token usage additionalProperties: false required: - - input_tokens - - output_tokens - - total_tokens + - input_tokens + - output_tokens + - total_tokens title: OpenAIResponseUsage description: Usage information for OpenAI response. ResponseGuardrailSpec: @@ -6373,16 +5819,15 @@ components: description: The type/identifier of the guardrail. additionalProperties: false required: - - type + - type title: ResponseGuardrailSpec - description: >- - Specification for a guardrail to apply during response generation. + description: Specification for a guardrail to apply during response generation. OpenAIResponseInputTool: oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' discriminator: propertyName: type mapping: @@ -6408,100 +5853,92 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) HTTP headers to include when connecting to the server + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) HTTP headers to include when connecting to the server require_approval: oneOf: - - type: string - const: always - - type: string - const: never - - type: object - properties: - always: - type: array - items: - type: string - description: >- - (Optional) List of tool names that always require approval - never: - type: array - items: - type: string - description: >- - (Optional) List of tool names that never require approval - additionalProperties: false - title: ApprovalFilter - description: >- - Filter configuration for MCP tool approval requirements. + - type: string + const: always + - type: string + const: never + - type: object + properties: + always: + type: array + items: + type: string + description: (Optional) List of tool names that always require approval + never: + type: array + items: + type: string + description: (Optional) List of tool names that never require approval + additionalProperties: false + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. default: never - description: >- - Approval requirement for tool calls ("always", "never", or filter) + description: Approval requirement for tool calls ("always", "never", or + filter) allowed_tools: oneOf: - - type: array - items: - type: string - - type: object - properties: - tool_names: - type: array - items: - type: string - description: >- - (Optional) List of specific tool names that are allowed - additionalProperties: false - title: AllowedToolsFilter - description: >- - Filter configuration for restricting which MCP tools can be used. - description: >- - (Optional) Restriction on which tools can be used from this server + - type: array + items: + type: string + - type: object + properties: + tool_names: + type: array + items: + type: string + description: (Optional) List of specific tool names that are allowed + additionalProperties: false + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can + be used. + description: (Optional) Restriction on which tools can be used from this + server additionalProperties: false required: - - type - - server_label - - server_url - - require_approval + - type + - server_label + - server_url + - require_approval title: OpenAIResponseInputToolMCP - description: >- - Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + description: Model Context Protocol (MCP) tool configuration for OpenAI response + inputs. CreateOpenaiResponseRequest: type: object properties: input: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIResponseInput' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIResponseInput' description: Input message(s) to create the response. model: type: string description: The underlying LLM used for completions. prompt: $ref: '#/components/schemas/OpenAIResponsePrompt' - description: >- - (Optional) Prompt object with ID, version, and variables. + description: (Optional) Prompt object with ID, version, and variables. instructions: type: string previous_response_id: type: string - description: >- - (Optional) if specified, the new response will be a continuation of the - previous response. This can be used to easily fork-off new responses from - existing responses. + description: (Optional) if specified, the new response will be a continuation + of the previous response. This can be used to easily fork-off new responses + from existing responses. conversation: type: string - description: >- - (Optional) The ID of a conversation to add the response to. Must begin - with 'conv_'. Input and output messages will be automatically added to - the conversation. + description: (Optional) The ID of a conversation to add the response to. + Must begin with 'conv_'. Input and output messages will be automatically + added to the conversation. store: type: boolean stream: @@ -6518,26 +5955,23 @@ components: type: array items: type: string - description: >- - (Optional) Additional fields to include in the response. + description: (Optional) Additional fields to include in the response. max_infer_iters: type: integer additionalProperties: false required: - - input - - model + - input + - model title: CreateOpenaiResponseRequest OpenAIResponseObject: type: object properties: created_at: type: integer - description: >- - Unix timestamp when the response was created + description: Unix timestamp when the response was created error: $ref: '#/components/schemas/OpenAIResponseError' - description: >- - (Optional) Error details if the response generation failed + description: (Optional) Error details if the response generation failed id: type: string description: Unique identifier for this response @@ -6548,74 +5982,62 @@ components: type: string const: response default: response - description: >- - Object type identifier, always "response" + description: Object type identifier, always "response" output: type: array items: $ref: '#/components/schemas/OpenAIResponseOutput' - description: >- - List of generated output items (messages, tool calls, etc.) + description: List of generated output items (messages, tool calls, etc.) parallel_tool_calls: type: boolean default: false - description: >- - Whether tool calls can be executed in parallel + description: Whether tool calls can be executed in parallel previous_response_id: type: string - description: >- - (Optional) ID of the previous response in a conversation + description: (Optional) ID of the previous response in a conversation prompt: $ref: '#/components/schemas/OpenAIResponsePrompt' - description: >- - (Optional) Reference to a prompt template and its variables. + description: (Optional) Reference to a prompt template and its variables. status: type: string - description: >- - Current status of the response generation + description: Current status of the response generation temperature: type: number - description: >- - (Optional) Sampling temperature used for generation + description: (Optional) Sampling temperature used for generation text: $ref: '#/components/schemas/OpenAIResponseText' - description: >- - Text formatting configuration for the response + description: Text formatting configuration for the response top_p: type: number - description: >- - (Optional) Nucleus sampling parameter used for generation + description: (Optional) Nucleus sampling parameter used for generation tools: type: array items: $ref: '#/components/schemas/OpenAIResponseTool' - description: >- - (Optional) An array of tools the model may call while generating a response. + description: (Optional) An array of tools the model may call while generating + a response. truncation: type: string - description: >- - (Optional) Truncation strategy applied to the response + description: (Optional) Truncation strategy applied to the response usage: $ref: '#/components/schemas/OpenAIResponseUsage' - description: >- - (Optional) Token usage information for the response + description: (Optional) Token usage information for the response instructions: type: string - description: >- - (Optional) System message inserted into the model's context + description: (Optional) System message inserted into the model's context additionalProperties: false required: - - created_at - - id - - model - - object - - output - - parallel_tool_calls - - status - - text + - created_at + - id + - model + - object + - output + - parallel_tool_calls + - status + - text title: OpenAIResponseObject - description: >- - Complete OpenAI response object containing generation results and metadata. + description: Complete OpenAI response object containing generation results and + metadata. OpenAIResponseContentPartOutputText: type: object properties: @@ -6623,8 +6045,7 @@ components: type: string const: output_text default: output_text - description: >- - Content part type identifier, always "output_text" + description: Content part type identifier, always "output_text" text: type: string description: Text emitted for this content part @@ -6632,49 +6053,44 @@ components: type: array items: $ref: '#/components/schemas/OpenAIResponseAnnotations' - description: >- - Structured annotations associated with the text + description: Structured annotations associated with the text logprobs: type: array items: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) Token log probability details additionalProperties: false required: - - type - - text - - annotations + - type + - text + - annotations title: OpenAIResponseContentPartOutputText - description: >- - Text content within a streamed response part. - "OpenAIResponseContentPartReasoningSummary": + description: Text content within a streamed response part. + OpenAIResponseContentPartReasoningSummary: type: object properties: type: type: string const: summary_text default: summary_text - description: >- - Content part type identifier, always "summary_text" + description: Content part type identifier, always "summary_text" text: type: string description: Summary text additionalProperties: false required: - - type - - text - title: >- - OpenAIResponseContentPartReasoningSummary - description: >- - Reasoning summary part in a streamed response. + - type + - text + title: OpenAIResponseContentPartReasoningSummary + description: Reasoning summary part in a streamed response. OpenAIResponseContentPartReasoningText: type: object properties: @@ -6682,56 +6098,54 @@ components: type: string const: reasoning_text default: reasoning_text - description: >- - Content part type identifier, always "reasoning_text" + description: Content part type identifier, always "reasoning_text" text: type: string description: Reasoning text supplied by the model additionalProperties: false required: - - type - - text + - type + - text title: OpenAIResponseContentPartReasoningText - description: >- - Reasoning text emitted as part of a streamed response. + description: Reasoning text emitted as part of a streamed response. OpenAIResponseObjectStream: oneOf: - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' discriminator: propertyName: type mapping: @@ -6771,7 +6185,7 @@ components: response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' - "OpenAIResponseObjectStreamResponseCompleted": + OpenAIResponseObjectStreamResponseCompleted: type: object properties: response: @@ -6781,40 +6195,34 @@ components: type: string const: response.completed default: response.completed - description: >- - Event type identifier, always "response.completed" + description: Event type identifier, always "response.completed" additionalProperties: false required: - - response - - type - title: >- - OpenAIResponseObjectStreamResponseCompleted - description: >- - Streaming event indicating a response has been completed. - "OpenAIResponseObjectStreamResponseContentPartAdded": + - response + - type + title: OpenAIResponseObjectStreamResponseCompleted + description: Streaming event indicating a response has been completed. + OpenAIResponseObjectStreamResponseContentPartAdded: type: object properties: content_index: type: integer - description: >- - Index position of the part within the content array + description: Index position of the part within the content array response_id: type: string - description: >- - Unique identifier of the response containing this content + description: Unique identifier of the response containing this content item_id: type: string - description: >- - Unique identifier of the output item containing this content part + description: Unique identifier of the output item containing this content + part output_index: type: integer - description: >- - Index position of the output item in the response + description: Index position of the output item in the response part: oneOf: - - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' + - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' discriminator: propertyName: type mapping: @@ -6824,51 +6232,45 @@ components: description: The content part that was added sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.content_part.added default: response.content_part.added - description: >- - Event type identifier, always "response.content_part.added" + description: Event type identifier, always "response.content_part.added" additionalProperties: false required: - - content_index - - response_id - - item_id - - output_index - - part - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseContentPartAdded - description: >- - Streaming event for when a new content part is added to a response item. - "OpenAIResponseObjectStreamResponseContentPartDone": + - content_index + - response_id + - item_id + - output_index + - part + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseContentPartAdded + description: Streaming event for when a new content part is added to a response + item. + OpenAIResponseObjectStreamResponseContentPartDone: type: object properties: content_index: type: integer - description: >- - Index position of the part within the content array + description: Index position of the part within the content array response_id: type: string - description: >- - Unique identifier of the response containing this content + description: Unique identifier of the response containing this content item_id: type: string - description: >- - Unique identifier of the output item containing this content part + description: Unique identifier of the output item containing this content + part output_index: type: integer - description: >- - Index position of the output item in the response + description: Index position of the output item in the response part: oneOf: - - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' + - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' discriminator: propertyName: type mapping: @@ -6878,28 +6280,24 @@ components: description: The completed content part sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.content_part.done default: response.content_part.done - description: >- - Event type identifier, always "response.content_part.done" + description: Event type identifier, always "response.content_part.done" additionalProperties: false required: - - content_index - - response_id - - item_id - - output_index - - part - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseContentPartDone - description: >- - Streaming event for when a content part is completed. - "OpenAIResponseObjectStreamResponseCreated": + - content_index + - response_id + - item_id + - output_index + - part + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseContentPartDone + description: Streaming event for when a content part is completed. + OpenAIResponseObjectStreamResponseCreated: type: object properties: response: @@ -6909,16 +6307,13 @@ components: type: string const: response.created default: response.created - description: >- - Event type identifier, always "response.created" + description: Event type identifier, always "response.created" additionalProperties: false required: - - response - - type - title: >- - OpenAIResponseObjectStreamResponseCreated - description: >- - Streaming event indicating a new response has been created. + - response + - type + title: OpenAIResponseObjectStreamResponseCreated + description: Streaming event indicating a new response has been created. OpenAIResponseObjectStreamResponseFailed: type: object properties: @@ -6927,188 +6322,153 @@ components: description: Response object describing the failure sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.failed default: response.failed - description: >- - Event type identifier, always "response.failed" + description: Event type identifier, always "response.failed" additionalProperties: false required: - - response - - sequence_number - - type + - response + - sequence_number + - type title: OpenAIResponseObjectStreamResponseFailed - description: >- - Streaming event emitted when a response fails. - "OpenAIResponseObjectStreamResponseFileSearchCallCompleted": + description: Streaming event emitted when a response fails. + OpenAIResponseObjectStreamResponseFileSearchCallCompleted: type: object properties: item_id: type: string - description: >- - Unique identifier of the completed file search call + description: Unique identifier of the completed file search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.file_search_call.completed default: response.file_search_call.completed - description: >- - Event type identifier, always "response.file_search_call.completed" + description: Event type identifier, always "response.file_search_call.completed" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFileSearchCallCompleted - description: >- - Streaming event for completed file search calls. - "OpenAIResponseObjectStreamResponseFileSearchCallInProgress": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted + description: Streaming event for completed file search calls. + OpenAIResponseObjectStreamResponseFileSearchCallInProgress: type: object properties: item_id: type: string - description: >- - Unique identifier of the file search call + description: Unique identifier of the file search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.file_search_call.in_progress default: response.file_search_call.in_progress - description: >- - Event type identifier, always "response.file_search_call.in_progress" + description: Event type identifier, always "response.file_search_call.in_progress" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFileSearchCallInProgress - description: >- - Streaming event for file search calls in progress. - "OpenAIResponseObjectStreamResponseFileSearchCallSearching": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress + description: Streaming event for file search calls in progress. + OpenAIResponseObjectStreamResponseFileSearchCallSearching: type: object properties: item_id: type: string - description: >- - Unique identifier of the file search call + description: Unique identifier of the file search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.file_search_call.searching default: response.file_search_call.searching - description: >- - Event type identifier, always "response.file_search_call.searching" + description: Event type identifier, always "response.file_search_call.searching" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFileSearchCallSearching - description: >- - Streaming event for file search currently searching. - "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFileSearchCallSearching + description: Streaming event for file search currently searching. + OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta: type: object properties: delta: type: string - description: >- - Incremental function call arguments being added + description: Incremental function call arguments being added item_id: type: string - description: >- - Unique identifier of the function call being updated + description: Unique identifier of the function call being updated output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.function_call_arguments.delta default: response.function_call_arguments.delta - description: >- - Event type identifier, always "response.function_call_arguments.delta" + description: Event type identifier, always "response.function_call_arguments.delta" additionalProperties: false required: - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta - description: >- - Streaming event for incremental function call argument updates. - "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone": + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta + description: Streaming event for incremental function call argument updates. + OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone: type: object properties: arguments: type: string - description: >- - Final complete arguments JSON string for the function call + description: Final complete arguments JSON string for the function call item_id: type: string - description: >- - Unique identifier of the completed function call + description: Unique identifier of the completed function call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.function_call_arguments.done default: response.function_call_arguments.done - description: >- - Event type identifier, always "response.function_call_arguments.done" + description: Event type identifier, always "response.function_call_arguments.done" additionalProperties: false required: - - arguments - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone - description: >- - Streaming event for when function call arguments are completed. - "OpenAIResponseObjectStreamResponseInProgress": + - arguments + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone + description: Streaming event for when function call arguments are completed. + OpenAIResponseObjectStreamResponseInProgress: type: object properties: response: @@ -7116,50 +6476,41 @@ components: description: Current response state while in progress sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.in_progress default: response.in_progress - description: >- - Event type identifier, always "response.in_progress" + description: Event type identifier, always "response.in_progress" additionalProperties: false required: - - response - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseInProgress - description: >- - Streaming event indicating the response remains in progress. - "OpenAIResponseObjectStreamResponseIncomplete": + - response + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseInProgress + description: Streaming event indicating the response remains in progress. + OpenAIResponseObjectStreamResponseIncomplete: type: object properties: response: $ref: '#/components/schemas/OpenAIResponseObject' - description: >- - Response object describing the incomplete state + description: Response object describing the incomplete state sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.incomplete default: response.incomplete - description: >- - Event type identifier, always "response.incomplete" + description: Event type identifier, always "response.incomplete" additionalProperties: false required: - - response - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseIncomplete - description: >- - Streaming event emitted when a response ends in an incomplete state. - "OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": + - response + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseIncomplete + description: Streaming event emitted when a response ends in an incomplete state. + OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta: type: object properties: delta: @@ -7176,14 +6527,13 @@ components: default: response.mcp_call.arguments.delta additionalProperties: false required: - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta - "OpenAIResponseObjectStreamResponseMcpCallArgumentsDone": + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta + OpenAIResponseObjectStreamResponseMcpCallArgumentsDone: type: object properties: arguments: @@ -7200,54 +6550,47 @@ components: default: response.mcp_call.arguments.done additionalProperties: false required: - - arguments - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallArgumentsDone - "OpenAIResponseObjectStreamResponseMcpCallCompleted": + - arguments + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone + OpenAIResponseObjectStreamResponseMcpCallCompleted: type: object properties: sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.mcp_call.completed default: response.mcp_call.completed - description: >- - Event type identifier, always "response.mcp_call.completed" + description: Event type identifier, always "response.mcp_call.completed" additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallCompleted + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallCompleted description: Streaming event for completed MCP calls. - "OpenAIResponseObjectStreamResponseMcpCallFailed": + OpenAIResponseObjectStreamResponseMcpCallFailed: type: object properties: sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.mcp_call.failed default: response.mcp_call.failed - description: >- - Event type identifier, always "response.mcp_call.failed" + description: Event type identifier, always "response.mcp_call.failed" additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallFailed + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallFailed description: Streaming event for failed MCP calls. - "OpenAIResponseObjectStreamResponseMcpCallInProgress": + OpenAIResponseObjectStreamResponseMcpCallInProgress: type: object properties: item_id: @@ -7255,29 +6598,24 @@ components: description: Unique identifier of the MCP call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.mcp_call.in_progress default: response.mcp_call.in_progress - description: >- - Event type identifier, always "response.mcp_call.in_progress" + description: Event type identifier, always "response.mcp_call.in_progress" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallInProgress - description: >- - Streaming event for MCP calls in progress. - "OpenAIResponseObjectStreamResponseMcpListToolsCompleted": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallInProgress + description: Streaming event for MCP calls in progress. + OpenAIResponseObjectStreamResponseMcpListToolsCompleted: type: object properties: sequence_number: @@ -7288,11 +6626,10 @@ components: default: response.mcp_list_tools.completed additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpListToolsCompleted - "OpenAIResponseObjectStreamResponseMcpListToolsFailed": + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted + OpenAIResponseObjectStreamResponseMcpListToolsFailed: type: object properties: sequence_number: @@ -7303,11 +6640,10 @@ components: default: response.mcp_list_tools.failed additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpListToolsFailed - "OpenAIResponseObjectStreamResponseMcpListToolsInProgress": + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpListToolsFailed + OpenAIResponseObjectStreamResponseMcpListToolsInProgress: type: object properties: sequence_number: @@ -7318,26 +6654,24 @@ components: default: response.mcp_list_tools.in_progress additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpListToolsInProgress - "OpenAIResponseObjectStreamResponseOutputItemAdded": + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress + OpenAIResponseObjectStreamResponseOutputItemAdded: type: object properties: response_id: type: string - description: >- - Unique identifier of the response containing this output + description: Unique identifier of the response containing this output item: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: @@ -7348,49 +6682,42 @@ components: mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - description: >- - The output item that was added (message, tool call, etc.) + description: The output item that was added (message, tool call, etc.) output_index: type: integer - description: >- - Index position of this item in the output list + description: Index position of this item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_item.added default: response.output_item.added - description: >- - Event type identifier, always "response.output_item.added" + description: Event type identifier, always "response.output_item.added" additionalProperties: false required: - - response_id - - item - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputItemAdded - description: >- - Streaming event for when a new output item is added to the response. - "OpenAIResponseObjectStreamResponseOutputItemDone": + - response_id + - item + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputItemAdded + description: Streaming event for when a new output item is added to the response. + OpenAIResponseObjectStreamResponseOutputItemDone: type: object properties: response_id: type: string - description: >- - Unique identifier of the response containing this output + description: Unique identifier of the response containing this output item: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: @@ -7401,58 +6728,50 @@ components: mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - description: >- - The completed output item (message, tool call, etc.) + description: The completed output item (message, tool call, etc.) output_index: type: integer - description: >- - Index position of this item in the output list + description: Index position of this item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_item.done default: response.output_item.done - description: >- - Event type identifier, always "response.output_item.done" + description: Event type identifier, always "response.output_item.done" additionalProperties: false required: - - response_id - - item - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputItemDone - description: >- - Streaming event for when an output item is completed. - "OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded": + - response_id + - item + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputItemDone + description: Streaming event for when an output item is completed. + OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded: type: object properties: item_id: type: string - description: >- - Unique identifier of the item to which the annotation is being added + description: Unique identifier of the item to which the annotation is being + added output_index: type: integer - description: >- - Index position of the output item in the response's output array + description: Index position of the output item in the response's output + array content_index: type: integer - description: >- - Index position of the content part within the output item + description: Index position of the content part within the output item annotation_index: type: integer - description: >- - Index of the annotation within the content part + description: Index of the annotation within the content part annotation: oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' discriminator: propertyName: type mapping: @@ -7463,28 +6782,24 @@ components: description: The annotation object being added sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_text.annotation.added default: response.output_text.annotation.added - description: >- - Event type identifier, always "response.output_text.annotation.added" + description: Event type identifier, always "response.output_text.annotation.added" additionalProperties: false required: - - item_id - - output_index - - content_index - - annotation_index - - annotation - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded - description: >- - Streaming event for when an annotation is added to output text. - "OpenAIResponseObjectStreamResponseOutputTextDelta": + - item_id + - output_index + - content_index + - annotation_index + - annotation + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded + description: Streaming event for when an annotation is added to output text. + OpenAIResponseObjectStreamResponseOutputTextDelta: type: object properties: content_index: @@ -7495,35 +6810,29 @@ components: description: Incremental text content being added item_id: type: string - description: >- - Unique identifier of the output item being updated + description: Unique identifier of the output item being updated output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_text.delta default: response.output_text.delta - description: >- - Event type identifier, always "response.output_text.delta" + description: Event type identifier, always "response.output_text.delta" additionalProperties: false required: - - content_index - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputTextDelta - description: >- - Streaming event for incremental text content updates. - "OpenAIResponseObjectStreamResponseOutputTextDone": + - content_index + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputTextDelta + description: Streaming event for incremental text content updates. + OpenAIResponseObjectStreamResponseOutputTextDone: type: object properties: content_index: @@ -7531,39 +6840,32 @@ components: description: Index position within the text content text: type: string - description: >- - Final complete text content of the output item + description: Final complete text content of the output item item_id: type: string - description: >- - Unique identifier of the completed output item + description: Unique identifier of the completed output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_text.done default: response.output_text.done - description: >- - Event type identifier, always "response.output_text.done" + description: Event type identifier, always "response.output_text.done" additionalProperties: false required: - - content_index - - text - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputTextDone - description: >- - Streaming event for when text output is completed. - "OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded": + - content_index + - text + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputTextDone + description: Streaming event for when text output is completed. + OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded: type: object properties: item_id: @@ -7577,31 +6879,26 @@ components: description: The summary part that was added sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_part.added default: response.reasoning_summary_part.added - description: >- - Event type identifier, always "response.reasoning_summary_part.added" + description: Event type identifier, always "response.reasoning_summary_part.added" additionalProperties: false required: - - item_id - - output_index - - part - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded - description: >- - Streaming event for when a new reasoning summary part is added. - "OpenAIResponseObjectStreamResponseReasoningSummaryPartDone": + - item_id + - output_index + - part + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded + description: Streaming event for when a new reasoning summary part is added. + OpenAIResponseObjectStreamResponseReasoningSummaryPartDone: type: object properties: item_id: @@ -7615,31 +6912,26 @@ components: description: The completed summary part sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_part.done default: response.reasoning_summary_part.done - description: >- - Event type identifier, always "response.reasoning_summary_part.done" + description: Event type identifier, always "response.reasoning_summary_part.done" additionalProperties: false required: - - item_id - - output_index - - part - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryPartDone - description: >- - Streaming event for when a reasoning summary part is completed. - "OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta": + - item_id + - output_index + - part + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone + description: Streaming event for when a reasoning summary part is completed. + OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta: type: object properties: delta: @@ -7653,31 +6945,26 @@ components: description: Index position of the output item sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_text.delta default: response.reasoning_summary_text.delta - description: >- - Event type identifier, always "response.reasoning_summary_text.delta" + description: Event type identifier, always "response.reasoning_summary_text.delta" additionalProperties: false required: - - delta - - item_id - - output_index - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta - description: >- - Streaming event for incremental reasoning summary text updates. - "OpenAIResponseObjectStreamResponseReasoningSummaryTextDone": + - delta + - item_id + - output_index + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta + description: Streaming event for incremental reasoning summary text updates. + OpenAIResponseObjectStreamResponseReasoningSummaryTextDone: type: object properties: text: @@ -7691,111 +6978,92 @@ components: description: Index position of the output item sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_text.done default: response.reasoning_summary_text.done - description: >- - Event type identifier, always "response.reasoning_summary_text.done" + description: Event type identifier, always "response.reasoning_summary_text.done" additionalProperties: false required: - - text - - item_id - - output_index - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryTextDone - description: >- - Streaming event for when reasoning summary text is completed. - "OpenAIResponseObjectStreamResponseReasoningTextDelta": + - text + - item_id + - output_index + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone + description: Streaming event for when reasoning summary text is completed. + OpenAIResponseObjectStreamResponseReasoningTextDelta: type: object properties: content_index: type: integer - description: >- - Index position of the reasoning content part + description: Index position of the reasoning content part delta: type: string description: Incremental reasoning text being added item_id: type: string - description: >- - Unique identifier of the output item being updated + description: Unique identifier of the output item being updated output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.reasoning_text.delta default: response.reasoning_text.delta - description: >- - Event type identifier, always "response.reasoning_text.delta" + description: Event type identifier, always "response.reasoning_text.delta" additionalProperties: false required: - - content_index - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningTextDelta - description: >- - Streaming event for incremental reasoning text updates. - "OpenAIResponseObjectStreamResponseReasoningTextDone": + - content_index + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseReasoningTextDelta + description: Streaming event for incremental reasoning text updates. + OpenAIResponseObjectStreamResponseReasoningTextDone: type: object properties: content_index: type: integer - description: >- - Index position of the reasoning content part + description: Index position of the reasoning content part text: type: string description: Final complete reasoning text item_id: type: string - description: >- - Unique identifier of the completed output item + description: Unique identifier of the completed output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.reasoning_text.done default: response.reasoning_text.done - description: >- - Event type identifier, always "response.reasoning_text.done" + description: Event type identifier, always "response.reasoning_text.done" additionalProperties: false required: - - content_index - - text - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningTextDone - description: >- - Streaming event for when reasoning text is completed. - "OpenAIResponseObjectStreamResponseRefusalDelta": + - content_index + - text + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseReasoningTextDone + description: Streaming event for when reasoning text is completed. + OpenAIResponseObjectStreamResponseRefusalDelta: type: object properties: content_index: @@ -7809,31 +7077,26 @@ components: description: Unique identifier of the output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.refusal.delta default: response.refusal.delta - description: >- - Event type identifier, always "response.refusal.delta" + description: Event type identifier, always "response.refusal.delta" additionalProperties: false required: - - content_index - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseRefusalDelta - description: >- - Streaming event for incremental refusal text updates. - "OpenAIResponseObjectStreamResponseRefusalDone": + - content_index + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseRefusalDelta + description: Streaming event for incremental refusal text updates. + OpenAIResponseObjectStreamResponseRefusalDone: type: object properties: content_index: @@ -7847,62 +7110,51 @@ components: description: Unique identifier of the output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.refusal.done default: response.refusal.done - description: >- - Event type identifier, always "response.refusal.done" + description: Event type identifier, always "response.refusal.done" additionalProperties: false required: - - content_index - - refusal - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseRefusalDone - description: >- - Streaming event for when refusal text is completed. - "OpenAIResponseObjectStreamResponseWebSearchCallCompleted": + - content_index + - refusal + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseRefusalDone + description: Streaming event for when refusal text is completed. + OpenAIResponseObjectStreamResponseWebSearchCallCompleted: type: object properties: item_id: type: string - description: >- - Unique identifier of the completed web search call + description: Unique identifier of the completed web search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.web_search_call.completed default: response.web_search_call.completed - description: >- - Event type identifier, always "response.web_search_call.completed" + description: Event type identifier, always "response.web_search_call.completed" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseWebSearchCallCompleted - description: >- - Streaming event for completed web search calls. - "OpenAIResponseObjectStreamResponseWebSearchCallInProgress": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted + description: Streaming event for completed web search calls. + OpenAIResponseObjectStreamResponseWebSearchCallInProgress: type: object properties: item_id: @@ -7910,29 +7162,24 @@ components: description: Unique identifier of the web search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.web_search_call.in_progress default: response.web_search_call.in_progress - description: >- - Event type identifier, always "response.web_search_call.in_progress" + description: Event type identifier, always "response.web_search_call.in_progress" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseWebSearchCallInProgress - description: >- - Streaming event for web search calls in progress. - "OpenAIResponseObjectStreamResponseWebSearchCallSearching": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress + description: Streaming event for web search calls in progress. + OpenAIResponseObjectStreamResponseWebSearchCallSearching: type: object properties: item_id: @@ -7947,37 +7194,33 @@ components: default: response.web_search_call.searching additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseWebSearchCallSearching + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseWebSearchCallSearching OpenAIDeleteResponseObject: type: object properties: id: type: string - description: >- - Unique identifier of the deleted response + description: Unique identifier of the deleted response object: type: string const: response default: response - description: >- - Object type identifier, always "response" + description: Object type identifier, always "response" deleted: type: boolean default: true description: Deletion confirmation flag, always True additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: OpenAIDeleteResponseObject - description: >- - Response object confirming deletion of an OpenAI response. + description: Response object confirming deletion of an OpenAI response. ListOpenAIResponseInputItem: type: object properties: @@ -7993,11 +7236,10 @@ components: description: Object type identifier, always "list" additionalProperties: false required: - - data - - object + - data + - object title: ListOpenAIResponseInputItem - description: >- - List container for OpenAI response input items. + description: List container for OpenAI response input items. RunShieldRequest: type: object properties: @@ -8013,26 +7255,25 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The parameters of the shield. additionalProperties: false required: - - shield_id - - messages - - params + - shield_id + - messages + - params title: RunShieldRequest RunShieldResponse: type: object properties: violation: $ref: '#/components/schemas/SafetyViolation' - description: >- - (Optional) Safety violation detected by the shield, if any + description: (Optional) Safety violation detected by the shield, if any additionalProperties: false title: RunShieldResponse description: Response from running a safety shield. @@ -8044,47 +7285,43 @@ components: description: Severity level of the violation user_message: type: string - description: >- - (Optional) Message to convey to the user about the violation + description: (Optional) Message to convey to the user about the violation metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Additional metadata including specific violation codes for debugging and - telemetry + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Additional metadata including specific violation codes for + debugging and telemetry additionalProperties: false required: - - violation_level - - metadata + - violation_level + - metadata title: SafetyViolation - description: >- - Details of a safety violation detected by content moderation. + description: Details of a safety violation detected by content moderation. ViolationLevel: type: string enum: - - info - - warn - - error + - info + - warn + - error title: ViolationLevel description: Severity level of a safety violation. AggregationFunctionType: type: string enum: - - average - - weighted_average - - median - - categorical_count - - accuracy + - average + - weighted_average + - median + - categorical_count + - accuracy title: AggregationFunctionType - description: >- - Types of aggregation functions for scoring results. + description: Types of aggregation functions for scoring results. ArrayType: type: object properties: @@ -8095,7 +7332,7 @@ components: description: Discriminator type. Always "array" additionalProperties: false required: - - type + - type title: ArrayType description: Parameter type for array values. BasicScoringFnParams: @@ -8105,21 +7342,18 @@ components: $ref: '#/components/schemas/ScoringFnParamsType' const: basic default: basic - description: >- - The type of scoring function parameters, always basic + description: The type of scoring function parameters, always basic aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' - description: >- - Aggregation functions to apply to the scores of each row + description: Aggregation functions to apply to the scores of each row additionalProperties: false required: - - type - - aggregation_functions + - type + - aggregation_functions title: BasicScoringFnParams - description: >- - Parameters for basic scoring function configuration. + description: Parameters for basic scoring function configuration. BooleanType: type: object properties: @@ -8130,7 +7364,7 @@ components: description: Discriminator type. Always "boolean" additionalProperties: false required: - - type + - type title: BooleanType description: Parameter type for boolean values. ChatCompletionInputType: @@ -8140,14 +7374,12 @@ components: type: string const: chat_completion_input default: chat_completion_input - description: >- - Discriminator type. Always "chat_completion_input" + description: Discriminator type. Always "chat_completion_input" additionalProperties: false required: - - type + - type title: ChatCompletionInputType - description: >- - Parameter type for chat completion input. + description: Parameter type for chat completion input. CompletionInputType: type: object properties: @@ -8155,11 +7387,10 @@ components: type: string const: completion_input default: completion_input - description: >- - Discriminator type. Always "completion_input" + description: Discriminator type. Always "completion_input" additionalProperties: false required: - - type + - type title: CompletionInputType description: Parameter type for completion input. JsonType: @@ -8172,7 +7403,7 @@ components: description: Discriminator type. Always "json" additionalProperties: false required: - - type + - type title: JsonType description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: @@ -8182,37 +7413,31 @@ components: $ref: '#/components/schemas/ScoringFnParamsType' const: llm_as_judge default: llm_as_judge - description: >- - The type of scoring function parameters, always llm_as_judge + description: The type of scoring function parameters, always llm_as_judge judge_model: type: string - description: >- - Identifier of the LLM model to use as a judge for scoring + description: Identifier of the LLM model to use as a judge for scoring prompt_template: type: string - description: >- - (Optional) Custom prompt template for the judge model + description: (Optional) Custom prompt template for the judge model judge_score_regexes: type: array items: type: string - description: >- - Regexes to extract the answer from generated response + description: Regexes to extract the answer from generated response aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' - description: >- - Aggregation functions to apply to the scores of each row + description: Aggregation functions to apply to the scores of each row additionalProperties: false required: - - type - - judge_model - - judge_score_regexes - - aggregation_functions + - type + - judge_model + - judge_score_regexes + - aggregation_functions title: LLMAsJudgeScoringFnParams - description: >- - Parameters for LLM-as-judge scoring function configuration. + description: Parameters for LLM-as-judge scoring function configuration. NumberType: type: object properties: @@ -8223,7 +7448,7 @@ components: description: Discriminator type. Always "number" additionalProperties: false required: - - type + - type title: NumberType description: Parameter type for numeric values. ObjectType: @@ -8236,7 +7461,7 @@ components: description: Discriminator type. Always "object" additionalProperties: false required: - - type + - type title: ObjectType description: Parameter type for object values. RegexParserScoringFnParams: @@ -8246,28 +7471,24 @@ components: $ref: '#/components/schemas/ScoringFnParamsType' const: regex_parser default: regex_parser - description: >- - The type of scoring function parameters, always regex_parser + description: The type of scoring function parameters, always regex_parser parsing_regexes: type: array items: type: string - description: >- - Regex to extract the answer from generated response + description: Regex to extract the answer from generated response aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' - description: >- - Aggregation functions to apply to the scores of each row + description: Aggregation functions to apply to the scores of each row additionalProperties: false required: - - type - - parsing_regexes - - aggregation_functions + - type + - parsing_regexes + - aggregation_functions title: RegexParserScoringFnParams - description: >- - Parameters for regex parser scoring function configuration. + description: Parameters for regex parser scoring function configuration. ScoringFn: type: object properties: @@ -8280,42 +7501,41 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: scoring_function default: scoring_function - description: >- - The resource type, always scoring_function + description: The resource type, always scoring_function description: type: string metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object return_type: oneOf: - - $ref: '#/components/schemas/StringType' - - $ref: '#/components/schemas/NumberType' - - $ref: '#/components/schemas/BooleanType' - - $ref: '#/components/schemas/ArrayType' - - $ref: '#/components/schemas/ObjectType' - - $ref: '#/components/schemas/JsonType' - - $ref: '#/components/schemas/UnionType' - - $ref: '#/components/schemas/ChatCompletionInputType' - - $ref: '#/components/schemas/CompletionInputType' + - $ref: '#/components/schemas/StringType' + - $ref: '#/components/schemas/NumberType' + - $ref: '#/components/schemas/BooleanType' + - $ref: '#/components/schemas/ArrayType' + - $ref: '#/components/schemas/ObjectType' + - $ref: '#/components/schemas/JsonType' + - $ref: '#/components/schemas/UnionType' + - $ref: '#/components/schemas/ChatCompletionInputType' + - $ref: '#/components/schemas/CompletionInputType' discriminator: propertyName: type mapping: @@ -8332,19 +7552,18 @@ components: $ref: '#/components/schemas/ScoringFnParams' additionalProperties: false required: - - identifier - - provider_id - - type - - metadata - - return_type + - identifier + - provider_id + - type + - metadata + - return_type title: ScoringFn - description: >- - A scoring function resource for evaluating model outputs. + description: A scoring function resource for evaluating model outputs. ScoringFnParams: oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - - $ref: '#/components/schemas/RegexParserScoringFnParams' - - $ref: '#/components/schemas/BasicScoringFnParams' + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' + - $ref: '#/components/schemas/BasicScoringFnParams' discriminator: propertyName: type mapping: @@ -8354,12 +7573,11 @@ components: ScoringFnParamsType: type: string enum: - - llm_as_judge - - regex_parser - - basic + - llm_as_judge + - regex_parser + - basic title: ScoringFnParamsType - description: >- - Types of scoring function parameter configurations. + description: Types of scoring function parameter configurations. StringType: type: object properties: @@ -8370,7 +7588,7 @@ components: description: Discriminator type. Always "string" additionalProperties: false required: - - type + - type title: StringType description: Parameter type for string values. UnionType: @@ -8383,7 +7601,7 @@ components: description: Discriminator type. Always "union" additionalProperties: false required: - - type + - type title: UnionType description: Parameter type for union values. ListScoringFunctionsResponse: @@ -8395,19 +7613,19 @@ components: $ref: '#/components/schemas/ScoringFn' additionalProperties: false required: - - data + - data title: ListScoringFunctionsResponse ParamType: oneOf: - - $ref: '#/components/schemas/StringType' - - $ref: '#/components/schemas/NumberType' - - $ref: '#/components/schemas/BooleanType' - - $ref: '#/components/schemas/ArrayType' - - $ref: '#/components/schemas/ObjectType' - - $ref: '#/components/schemas/JsonType' - - $ref: '#/components/schemas/UnionType' - - $ref: '#/components/schemas/ChatCompletionInputType' - - $ref: '#/components/schemas/CompletionInputType' + - $ref: '#/components/schemas/StringType' + - $ref: '#/components/schemas/NumberType' + - $ref: '#/components/schemas/BooleanType' + - $ref: '#/components/schemas/ArrayType' + - $ref: '#/components/schemas/ObjectType' + - $ref: '#/components/schemas/JsonType' + - $ref: '#/components/schemas/UnionType' + - $ref: '#/components/schemas/ChatCompletionInputType' + - $ref: '#/components/schemas/CompletionInputType' discriminator: propertyName: type mapping: @@ -8425,8 +7643,7 @@ components: properties: scoring_fn_id: type: string - description: >- - The ID of the scoring function to register. + description: The ID of the scoring function to register. description: type: string description: The description of the scoring function. @@ -8435,22 +7652,20 @@ components: description: The return type of the scoring function. provider_scoring_fn_id: type: string - description: >- - The ID of the provider scoring function to use for the scoring function. + description: The ID of the provider scoring function to use for the scoring + function. provider_id: type: string - description: >- - The ID of the provider to use for the scoring function. + description: The ID of the provider to use for the scoring function. params: $ref: '#/components/schemas/ScoringFnParams' - description: >- - The parameters for the scoring function for benchmark eval, these can - be overridden for app eval. + description: The parameters for the scoring function for benchmark eval, + these can be overridden for app eval. additionalProperties: false required: - - scoring_fn_id - - description - - return_type + - scoring_fn_id + - description + - return_type title: RegisterScoringFunctionRequest ScoreRequest: type: object @@ -8461,25 +7676,24 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The rows to score. scoring_functions: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/ScoringFnParams' - - type: 'null' - description: >- - The scoring functions to use for the scoring. + - $ref: '#/components/schemas/ScoringFnParams' + - type: 'null' + description: The scoring functions to use for the scoring. additionalProperties: false required: - - input_rows - - scoring_functions + - input_rows + - scoring_functions title: ScoreRequest ScoreResponse: type: object @@ -8488,11 +7702,10 @@ components: type: object additionalProperties: $ref: '#/components/schemas/ScoringResult' - description: >- - A map of scoring function name to ScoringResult. + description: A map of scoring function name to ScoringResult. additionalProperties: false required: - - results + - results title: ScoreResponse description: The response from scoring. ScoringResult: @@ -8504,29 +7717,29 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The scoring result for each row. Each row is a map of column name to value. - aggregated_results: - type: object - additionalProperties: - oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object + description: The scoring result for each row. Each row is a map of column + name to value. + aggregated_results: + type: object + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Map of metric name to aggregated value additionalProperties: false required: - - score_rows - - aggregated_results + - score_rows + - aggregated_results title: ScoringResult description: A scoring result for a single row. ScoreBatchRequest: @@ -8539,39 +7752,34 @@ components: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/ScoringFnParams' - - type: 'null' - description: >- - The scoring functions to use for the scoring. + - $ref: '#/components/schemas/ScoringFnParams' + - type: 'null' + description: The scoring functions to use for the scoring. save_results_dataset: type: boolean - description: >- - Whether to save the results to a dataset. + description: Whether to save the results to a dataset. additionalProperties: false required: - - dataset_id - - scoring_functions - - save_results_dataset + - dataset_id + - scoring_functions + - save_results_dataset title: ScoreBatchRequest ScoreBatchResponse: type: object properties: dataset_id: type: string - description: >- - (Optional) The identifier of the dataset that was scored + description: (Optional) The identifier of the dataset that was scored results: type: object additionalProperties: $ref: '#/components/schemas/ScoringResult' - description: >- - A map of scoring function name to ScoringResult + description: A map of scoring function name to ScoringResult additionalProperties: false required: - - results + - results title: ScoreBatchResponse - description: >- - Response from batch scoring operations on datasets. + description: Response from batch scoring operations on datasets. Shield: type: object properties: @@ -8584,15 +7792,15 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: shield default: shield description: The resource type, always shield @@ -8600,22 +7808,20 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Configuration parameters for the shield + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Configuration parameters for the shield additionalProperties: false required: - - identifier - - provider_id - - type + - identifier + - provider_id + - type title: Shield - description: >- - A safety shield resource that can be used to check content. + description: A safety shield resource that can be used to check content. ListShieldsResponse: type: object properties: @@ -8625,19 +7831,17 @@ components: $ref: '#/components/schemas/Shield' additionalProperties: false required: - - data + - data title: ListShieldsResponse RegisterShieldRequest: type: object properties: shield_id: type: string - description: >- - The identifier of the shield to register. + description: The identifier of the shield to register. provider_shield_id: type: string - description: >- - The identifier of the shield in the provider. + description: The identifier of the shield in the provider. provider_id: type: string description: The identifier of the provider. @@ -8645,16 +7849,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The parameters of the shield. additionalProperties: false required: - - shield_id + - shield_id title: RegisterShieldRequest InvokeToolRequest: type: object @@ -8666,18 +7870,17 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - A dictionary of arguments to pass to the tool. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: A dictionary of arguments to pass to the tool. additionalProperties: false required: - - tool_name - - kwargs + - tool_name + - kwargs title: InvokeToolRequest ImageContentItem: type: object @@ -8686,40 +7889,37 @@ components: type: string const: image default: image - description: >- - Discriminator type of the content item. Always "image" + description: Discriminator type of the content item. Always "image" image: type: object properties: url: $ref: '#/components/schemas/URL' - description: >- - A URL of the image or data URL in the format of data:image/{type};base64,{data}. + description: A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits. data: type: string contentEncoding: base64 description: base64 encoded image data as string additionalProperties: false - description: >- - Image as a base64 encoded string or an URL + description: Image as a base64 encoded string or an URL additionalProperties: false required: - - type - - image + - type + - image title: ImageContentItem description: A image content item InterleavedContent: oneOf: - - type: string - - $ref: '#/components/schemas/InterleavedContentItem' - - type: array - items: - $ref: '#/components/schemas/InterleavedContentItem' + - type: string + - $ref: '#/components/schemas/InterleavedContentItem' + - type: array + items: + $ref: '#/components/schemas/InterleavedContentItem' InterleavedContentItem: oneOf: - - $ref: '#/components/schemas/ImageContentItem' - - $ref: '#/components/schemas/TextContentItem' + - $ref: '#/components/schemas/ImageContentItem' + - $ref: '#/components/schemas/TextContentItem' discriminator: propertyName: type mapping: @@ -8732,15 +7932,14 @@ components: type: string const: text default: text - description: >- - Discriminator type of the content item. Always "text" + description: Discriminator type of the content item. Always "text" text: type: string description: Text content additionalProperties: false required: - - type - - text + - type + - text title: TextContentItem description: A text content item ToolInvocationResult: @@ -8748,28 +7947,24 @@ components: properties: content: $ref: '#/components/schemas/InterleavedContent' - description: >- - (Optional) The output content from the tool execution + description: (Optional) The output content from the tool execution error_message: type: string - description: >- - (Optional) Error message if the tool execution failed + description: (Optional) Error message if the tool execution failed error_code: type: integer - description: >- - (Optional) Numeric error code if the tool execution failed + description: (Optional) Numeric error code if the tool execution failed metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional metadata about the tool execution + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional metadata about the tool execution additionalProperties: false title: ToolInvocationResult description: Result of a tool invocation. @@ -8781,7 +7976,7 @@ components: description: The URL string pointing to the resource additionalProperties: false required: - - uri + - uri title: URL description: A URL reference to external content. ToolDef: @@ -8789,57 +7984,51 @@ components: properties: toolgroup_id: type: string - description: >- - (Optional) ID of the tool group this tool belongs to + description: (Optional) ID of the tool group this tool belongs to name: type: string description: Name of the tool description: type: string - description: >- - (Optional) Human-readable description of what the tool does + description: (Optional) Human-readable description of what the tool does input_schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) JSON Schema for tool inputs (MCP inputSchema) + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) JSON Schema for tool inputs (MCP inputSchema) output_schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) JSON Schema for tool outputs (MCP outputSchema) + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) JSON Schema for tool outputs (MCP outputSchema) metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional metadata about the tool + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional metadata about the tool additionalProperties: false required: - - name + - name title: ToolDef - description: >- - Tool definition used in runtime contexts. + description: Tool definition used in runtime contexts. ListToolDefsResponse: type: object properties: @@ -8850,10 +8039,9 @@ components: description: List of tool definitions additionalProperties: false required: - - data + - data title: ListToolDefsResponse - description: >- - Response containing a list of tool definitions. + description: Response containing a list of tool definitions. ToolGroup: type: object properties: @@ -8866,42 +8054,39 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: tool_group default: tool_group description: Type of resource, always 'tool_group' mcp_endpoint: $ref: '#/components/schemas/URL' - description: >- - (Optional) Model Context Protocol endpoint for remote tools + description: (Optional) Model Context Protocol endpoint for remote tools args: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional arguments for the tool group + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional arguments for the tool group additionalProperties: false required: - - identifier - - provider_id - - type + - identifier + - provider_id + - type title: ToolGroup - description: >- - A group of related tools managed together. + description: A group of related tools managed together. ListToolGroupsResponse: type: object properties: @@ -8912,10 +8097,9 @@ components: description: List of tool groups additionalProperties: false required: - - data + - data title: ListToolGroupsResponse - description: >- - Response containing a list of tool groups. + description: Response containing a list of tool groups. RegisterToolGroupRequest: type: object properties: @@ -8924,163 +8108,142 @@ components: description: The ID of the tool group to register. provider_id: type: string - description: >- - The ID of the provider to use for the tool group. + description: The ID of the provider to use for the tool group. mcp_endpoint: $ref: '#/components/schemas/URL' - description: >- - The MCP endpoint to use for the tool group. + description: The MCP endpoint to use for the tool group. args: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - A dictionary of arguments to pass to the tool group. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: A dictionary of arguments to pass to the tool group. additionalProperties: false required: - - toolgroup_id - - provider_id + - toolgroup_id + - provider_id title: RegisterToolGroupRequest Chunk: type: object properties: content: $ref: '#/components/schemas/InterleavedContent' - description: >- - The content of the chunk, which can be interleaved text, images, or other - types. + description: The content of the chunk, which can be interleaved text, images, + or other types. chunk_id: type: string - description: >- - Unique identifier for the chunk. Must be provided explicitly. + description: Unique identifier for the chunk. Must be provided explicitly. metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Metadata associated with the chunk that will be used in the model context - during inference. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Metadata associated with the chunk that will be used in the + model context during inference. embedding: type: array items: type: number - description: >- - Optional embedding for the chunk. If not provided, it will be computed - later. + description: Optional embedding for the chunk. If not provided, it will + be computed later. chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' - description: >- - Metadata for the chunk that will NOT be used in the context during inference. - The `chunk_metadata` is required backend functionality. + description: Metadata for the chunk that will NOT be used in the context + during inference. The `chunk_metadata` is required backend functionality. additionalProperties: false required: - - content - - chunk_id - - metadata + - content + - chunk_id + - metadata title: Chunk - description: >- - A chunk of content that can be inserted into a vector database. + description: A chunk of content that can be inserted into a vector database. ChunkMetadata: type: object properties: chunk_id: type: string - description: >- - The ID of the chunk. If not set, it will be generated based on the document - ID and content. + description: The ID of the chunk. If not set, it will be generated based + on the document ID and content. document_id: type: string - description: >- - The ID of the document this chunk belongs to. + description: The ID of the document this chunk belongs to. source: type: string - description: >- - The source of the content, such as a URL, file path, or other identifier. + description: The source of the content, such as a URL, file path, or other + identifier. created_timestamp: type: integer - description: >- - An optional timestamp indicating when the chunk was created. + description: An optional timestamp indicating when the chunk was created. updated_timestamp: type: integer - description: >- - An optional timestamp indicating when the chunk was last updated. + description: An optional timestamp indicating when the chunk was last updated. chunk_window: type: string - description: >- - The window of the chunk, which can be used to group related chunks together. + description: The window of the chunk, which can be used to group related + chunks together. chunk_tokenizer: type: string - description: >- - The tokenizer used to create the chunk. Default is Tiktoken. + description: The tokenizer used to create the chunk. Default is Tiktoken. chunk_embedding_model: type: string - description: >- - The embedding model used to create the chunk's embedding. + description: The embedding model used to create the chunk's embedding. chunk_embedding_dimension: type: integer - description: >- - The dimension of the embedding vector for the chunk. + description: The dimension of the embedding vector for the chunk. content_token_count: type: integer - description: >- - The number of tokens in the content of the chunk. + description: The number of tokens in the content of the chunk. metadata_token_count: type: integer - description: >- - The number of tokens in the metadata of the chunk. + description: The number of tokens in the metadata of the chunk. additionalProperties: false 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. + 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.' InsertChunksRequest: type: object properties: vector_store_id: type: string - description: >- - The identifier of the vector database to insert the chunks into. + description: The identifier of the vector database to insert the chunks + into. chunks: type: array items: $ref: '#/components/schemas/Chunk' - description: >- - The chunks to insert. Each `Chunk` should contain content which can be - interleaved text, images, or other types. `metadata`: `dict[str, Any]` - and `embedding`: `List[float]` are optional. If `metadata` is provided, + description: 'The chunks to insert. Each `Chunk` should contain content + which can be interleaved text, images, or other types. `metadata`: `dict[str, + Any]` and `embedding`: `List[float]` are optional. If `metadata` is provided, you configure how Llama Stack formats the chunk during generation. If - `embedding` is not provided, it will be computed later. + `embedding` is not provided, it will be computed later.' ttl_seconds: type: integer description: The time to live of the chunks. additionalProperties: false required: - - vector_store_id - - chunks + - vector_store_id + - chunks title: InsertChunksRequest QueryChunksRequest: type: object properties: vector_store_id: type: string - description: >- - The identifier of the vector database to query. + description: The identifier of the vector database to query. query: $ref: '#/components/schemas/InterleavedContent' description: The query to search for. @@ -9088,17 +8251,17 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The parameters of the query. additionalProperties: false required: - - vector_store_id - - query + - vector_store_id + - query title: QueryChunksRequest QueryChunksResponse: type: object @@ -9107,53 +8270,45 @@ components: type: array items: $ref: '#/components/schemas/Chunk' - description: >- - List of content chunks returned from the query + description: List of content chunks returned from the query scores: type: array items: type: number - description: >- - Relevance scores corresponding to each returned chunk + description: Relevance scores corresponding to each returned chunk additionalProperties: false required: - - chunks - - scores + - chunks + - scores title: QueryChunksResponse - description: >- - Response from querying chunks in a vector database. + description: Response from querying chunks in a vector database. VectorStoreFileCounts: type: object properties: completed: type: integer - description: >- - Number of files that have been successfully processed + description: Number of files that have been successfully processed cancelled: type: integer - description: >- - Number of files that had their processing cancelled + description: Number of files that had their processing cancelled failed: type: integer description: Number of files that failed to process in_progress: type: integer - description: >- - Number of files currently being processed + description: Number of files currently being processed total: type: integer - description: >- - Total number of files in the vector store + description: Total number of files in the vector store additionalProperties: false required: - - completed - - cancelled - - failed - - in_progress - - total + - completed + - cancelled + - failed + - in_progress + - total title: VectorStoreFileCounts - description: >- - File processing status counts for a vector store. + description: File processing status counts for a vector store. VectorStoreListResponse: type: object properties: @@ -9168,22 +8323,20 @@ components: description: List of vector store objects first_id: type: string - description: >- - (Optional) ID of the first vector store in the list for pagination + description: (Optional) ID of the first vector store in the list for pagination last_id: type: string - description: >- - (Optional) ID of the last vector store in the list for pagination + description: (Optional) ID of the last vector store in the list for pagination has_more: type: boolean default: false - description: >- - Whether there are more vector stores available beyond this page + description: Whether there are more vector stores available beyond this + page additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: VectorStoreListResponse description: Response from listing vector stores. VectorStoreObject: @@ -9195,24 +8348,20 @@ components: object: type: string default: vector_store - description: >- - Object type identifier, always "vector_store" + description: Object type identifier, always "vector_store" created_at: type: integer - description: >- - Timestamp when the vector store was created + description: Timestamp when the vector store was created name: type: string description: (Optional) Name of the vector store usage_bytes: type: integer default: 0 - description: >- - Storage space used by the vector store in bytes + description: Storage space used by the vector store in bytes file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' - description: >- - File processing status counts for the vector store + description: File processing status counts for the vector store status: type: string default: completed @@ -9221,49 +8370,45 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Expiration policy for the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Expiration policy for the vector store expires_at: type: integer - description: >- - (Optional) Timestamp when the vector store will expire + description: (Optional) Timestamp when the vector store will expire last_active_at: type: integer - description: >- - (Optional) Timestamp of last activity on the vector store + description: (Optional) Timestamp of last activity on the vector store metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Set of key-value pairs that can be attached to the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Set of key-value pairs that can be attached to the vector store additionalProperties: false required: - - id - - object - - created_at - - usage_bytes - - file_counts - - status - - metadata + - id + - object + - created_at + - usage_bytes + - file_counts + - status + - metadata title: VectorStoreObject description: OpenAI Vector Store object. VectorStoreChunkingStrategy: oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' discriminator: propertyName: type mapping: @@ -9276,14 +8421,12 @@ components: type: string const: auto default: auto - description: >- - Strategy type, always "auto" for automatic chunking + description: Strategy type, always "auto" for automatic chunking additionalProperties: false required: - - type + - type title: VectorStoreChunkingStrategyAuto - description: >- - Automatic chunking strategy for vector store files. + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: type: object properties: @@ -9291,40 +8434,35 @@ components: type: string const: static default: static - description: >- - Strategy type, always "static" for static chunking + description: Strategy type, always "static" for static chunking static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - description: >- - Configuration parameters for the static chunking strategy + description: Configuration parameters for the static chunking strategy additionalProperties: false required: - - type - - static + - type + - static title: VectorStoreChunkingStrategyStatic - description: >- - Static chunking strategy with configurable parameters. + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: type: object properties: chunk_overlap_tokens: type: integer default: 400 - description: >- - Number of tokens to overlap between adjacent chunks + description: Number of tokens to overlap between adjacent chunks max_chunk_size_tokens: type: integer default: 800 - description: >- - Maximum number of tokens per chunk, must be between 100 and 4096 + description: Maximum number of tokens per chunk, must be between 100 and + 4096 additionalProperties: false required: - - chunk_overlap_tokens - - max_chunk_size_tokens + - chunk_overlap_tokens + - max_chunk_size_tokens title: VectorStoreChunkingStrategyStaticConfig - description: >- - Configuration for static chunking strategy. - "OpenAICreateVectorStoreRequestWithExtraBody": + description: Configuration for static chunking strategy. + OpenAICreateVectorStoreRequestWithExtraBody: type: object properties: name: @@ -9334,41 +8472,35 @@ components: type: array items: type: string - description: >- - List of file IDs to include in the vector store + description: List of file IDs to include in the vector store expires_after: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Expiration policy for the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Expiration policy for the vector store chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' - description: >- - (Optional) Strategy for splitting files into chunks + description: (Optional) Strategy for splitting files into chunks metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Set of key-value pairs that can be attached to the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Set of key-value pairs that can be attached to the vector store additionalProperties: false - title: >- - OpenAICreateVectorStoreRequestWithExtraBody - description: >- - Request to create a vector store with extra_body support. + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. OpenaiUpdateVectorStoreRequest: type: object properties: @@ -9379,26 +8511,24 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The expiration policy for a vector store. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The expiration policy for a vector store. metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Set of 16 key-value pairs that can be attached to an object. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Set of 16 key-value pairs that can be attached to an object. additionalProperties: false title: OpenaiUpdateVectorStoreRequest VectorStoreDeleteResponse: @@ -9406,58 +8536,50 @@ components: properties: id: type: string - description: >- - Unique identifier of the deleted vector store + description: Unique identifier of the deleted vector store object: type: string default: vector_store.deleted - description: >- - Object type identifier for the deletion response + description: Object type identifier for the deletion response deleted: type: boolean default: true - description: >- - Whether the deletion operation was successful + description: Whether the deletion operation was successful additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: VectorStoreDeleteResponse description: Response from deleting a vector store. - "OpenAICreateVectorStoreFileBatchRequestWithExtraBody": + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: type: object properties: file_ids: type: array items: type: string - description: >- - A list of File IDs that the vector store should use + description: A list of File IDs that the vector store should use attributes: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Key-value attributes to store with the files + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Key-value attributes to store with the files chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' - description: >- - (Optional) The chunking strategy used to chunk the file(s). Defaults to - auto + description: (Optional) The chunking strategy used to chunk the file(s). + Defaults to auto additionalProperties: false required: - - file_ids - title: >- - OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: >- - Request to create a vector store file batch with extra_body support. + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: type: object properties: @@ -9467,66 +8589,58 @@ components: object: type: string default: vector_store.file_batch - description: >- - Object type identifier, always "vector_store.file_batch" + description: Object type identifier, always "vector_store.file_batch" created_at: type: integer - description: >- - Timestamp when the file batch was created + description: Timestamp when the file batch was created vector_store_id: type: string - description: >- - ID of the vector store containing the file batch + description: ID of the vector store containing the file batch status: $ref: '#/components/schemas/VectorStoreFileStatus' - description: >- - Current processing status of the file batch + description: Current processing status of the file batch file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' - description: >- - File processing status counts for the batch + description: File processing status counts for the batch additionalProperties: false required: - - id - - object - - created_at - - vector_store_id - - status - - file_counts + - id + - object + - created_at + - vector_store_id + - status + - file_counts title: VectorStoreFileBatchObject description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: oneOf: - - type: string - const: completed - - type: string - const: in_progress - - type: string - const: cancelled - - type: string - const: failed + - type: string + const: completed + - type: string + const: in_progress + - type: string + const: cancelled + - type: string + const: failed VectorStoreFileLastError: type: object properties: code: oneOf: - - type: string - const: server_error - - type: string - const: rate_limit_exceeded - description: >- - Error code indicating the type of failure + - type: string + const: server_error + - type: string + const: rate_limit_exceeded + description: Error code indicating the type of failure message: type: string - description: >- - Human-readable error message describing the failure + description: Human-readable error message describing the failure additionalProperties: false required: - - code - - message + - code + - message title: VectorStoreFileLastError - description: >- - Error information for failed vector store file processing. + description: Error information for failed vector store file processing. VectorStoreFileObject: type: object properties: @@ -9536,39 +8650,34 @@ components: object: type: string default: vector_store.file - description: >- - Object type identifier, always "vector_store.file" + description: Object type identifier, always "vector_store.file" attributes: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Key-value attributes associated with the file + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Key-value attributes associated with the file chunking_strategy: oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - description: >- - Strategy used for splitting the file into chunks + description: Strategy used for splitting the file into chunks created_at: type: integer - description: >- - Timestamp when the file was added to the vector store + description: Timestamp when the file was added to the vector store last_error: $ref: '#/components/schemas/VectorStoreFileLastError' - description: >- - (Optional) Error information if file processing failed + description: (Optional) Error information if file processing failed status: $ref: '#/components/schemas/VectorStoreFileStatus' description: Current processing status of the file @@ -9578,18 +8687,17 @@ components: description: Storage space used by this file in bytes vector_store_id: type: string - description: >- - ID of the vector store containing this file + description: ID of the vector store containing this file additionalProperties: false required: - - id - - object - - attributes - - chunking_strategy - - created_at - - status - - usage_bytes - - vector_store_id + - id + - object + - attributes + - chunking_strategy + - created_at + - status + - usage_bytes + - vector_store_id title: VectorStoreFileObject description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: @@ -9603,29 +8711,24 @@ components: type: array items: $ref: '#/components/schemas/VectorStoreFileObject' - description: >- - List of vector store file objects in the batch + description: List of vector store file objects in the batch first_id: type: string - description: >- - (Optional) ID of the first file in the list for pagination + description: (Optional) ID of the first file in the list for pagination last_id: type: string - description: >- - (Optional) ID of the last file in the list for pagination + description: (Optional) ID of the last file in the list for pagination has_more: type: boolean default: false - description: >- - Whether there are more files available beyond this page + description: Whether there are more files available beyond this page additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: VectorStoreFilesListInBatchResponse - description: >- - Response from listing files in a vector store file batch. + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: type: object properties: @@ -9640,51 +8743,45 @@ components: description: List of vector store file objects first_id: type: string - description: >- - (Optional) ID of the first file in the list for pagination + description: (Optional) ID of the first file in the list for pagination last_id: type: string - description: >- - (Optional) ID of the last file in the list for pagination + description: (Optional) ID of the last file in the list for pagination has_more: type: boolean default: false - description: >- - Whether there are more files available beyond this page + description: Whether there are more files available beyond this page additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: VectorStoreListFilesResponse - description: >- - Response from listing files in a vector store. + description: Response from listing files in a vector store. OpenaiAttachFileToVectorStoreRequest: type: object properties: file_id: type: string - description: >- - The ID of the file to attach to the vector store. + description: The ID of the file to attach to the vector store. attributes: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The key-value attributes stored with the file, which can be used for filtering. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The key-value attributes stored with the file, which can be + used for filtering. chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' - description: >- - The chunking strategy to use for the file. + description: The chunking strategy to use for the file. additionalProperties: false required: - - file_id + - file_id title: OpenaiAttachFileToVectorStoreRequest OpenaiUpdateVectorStoreFileRequest: type: object @@ -9693,17 +8790,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The updated key-value attributes to store with the file. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The updated key-value attributes to store with the file. additionalProperties: false required: - - attributes + - attributes title: OpenaiUpdateVectorStoreFileRequest VectorStoreFileDeleteResponse: type: object @@ -9714,136 +8810,119 @@ components: object: type: string default: vector_store.file.deleted - description: >- - Object type identifier for the deletion response + description: Object type identifier for the deletion response deleted: type: boolean default: true - description: >- - Whether the deletion operation was successful + description: Whether the deletion operation was successful additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: VectorStoreFileDeleteResponse - description: >- - Response from deleting a vector store file. + description: Response from deleting a vector store file. VectorStoreContent: type: object properties: type: type: string const: text - description: >- - Content type, currently only "text" is supported + description: Content type, currently only "text" is supported text: type: string description: The actual text content additionalProperties: false required: - - type - - text + - type + - text title: VectorStoreContent - description: >- - Content item from a vector store file or search result. - VectorStoreFileContentsResponse: + description: Content item from a vector store file or search result. + VectorStoreFileContentResponse: type: object + description: Represents the parsed content of a vector store file. properties: - file_id: + object: type: string - description: Unique identifier for the file - filename: - type: string - description: Name of the file - attributes: - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Key-value attributes associated with the file - content: + enum: + - vector_store.file_content.page + description: The object type, which is always `vector_store.file_content.page` + x-stainless-const: true + data: type: array + description: Parsed content of the file. items: $ref: '#/components/schemas/VectorStoreContent' - description: List of content items from the file + has_more: + type: boolean + description: Indicates if there are more content pages to fetch. + next_page: + anyOf: + - type: string + description: The token for the next page, if any. + - type: 'null' additionalProperties: false required: - - file_id - - filename - - attributes - - content - title: VectorStoreFileContentsResponse - description: >- - Response from retrieving the contents of a vector store file. + - object + - data + - has_more + - next_page + title: VectorStoreFileContentResponse OpenaiSearchVectorStoreRequest: type: object properties: query: oneOf: - - type: string - - type: array - items: - type: string - description: >- - The query string or array for performing the search. + - type: string + - type: array + items: + type: string + description: The query string or array for performing the search. filters: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Filters based on file attributes to narrow the search results. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Filters based on file attributes to narrow the search results. max_num_results: type: integer - description: >- - Maximum number of results to return (1 to 50 inclusive, default 10). + description: Maximum number of results to return (1 to 50 inclusive, default + 10). ranking_options: type: object properties: ranker: type: string - description: >- - (Optional) Name of the ranking algorithm to use + description: (Optional) Name of the ranking algorithm to use score_threshold: type: number default: 0.0 - description: >- - (Optional) Minimum relevance score threshold for results + description: (Optional) Minimum relevance score threshold for results additionalProperties: false - description: >- - Ranking options for fine-tuning the search results. + description: Ranking options for fine-tuning the search results. rewrite_query: type: boolean - description: >- - Whether to rewrite the natural language query for vector search (default - false) + description: Whether to rewrite the natural language query for vector search + (default false) search_mode: type: string - description: >- - The search mode to use - "keyword", "vector", or "hybrid" (default "vector") + description: The search mode to use - "keyword", "vector", or "hybrid" (default + "vector") additionalProperties: false required: - - query + - query title: OpenaiSearchVectorStoreRequest VectorStoreSearchResponse: type: object properties: file_id: type: string - description: >- - Unique identifier of the file containing the result + description: Unique identifier of the file containing the result filename: type: string description: Name of the file containing the result @@ -9854,23 +8933,21 @@ components: type: object additionalProperties: oneOf: - - type: string - - type: number - - type: boolean - description: >- - (Optional) Key-value attributes associated with the file + - type: string + - type: number + - type: boolean + description: (Optional) Key-value attributes associated with the file content: type: array items: $ref: '#/components/schemas/VectorStoreContent' - description: >- - List of content items matching the search query + description: List of content items matching the search query additionalProperties: false required: - - file_id - - filename - - score - - content + - file_id + - filename + - score + - content title: VectorStoreSearchResponse description: Response from searching a vector store. VectorStoreSearchResponsePage: @@ -9879,14 +8956,12 @@ components: object: type: string default: vector_store.search_results.page - description: >- - Object type identifier for the search results page + description: Object type identifier for the search results page search_query: type: array items: type: string - description: >- - The original search query that was executed + description: The original search query that was executed data: type: array items: @@ -9895,21 +8970,18 @@ components: has_more: type: boolean default: false - description: >- - Whether there are more results available beyond this page + description: Whether there are more results available beyond this page next_page: type: string - description: >- - (Optional) Token for retrieving the next page of results + description: (Optional) Token for retrieving the next page of results additionalProperties: false required: - - object - - search_query - - data - - has_more + - object + - search_query + - data + - has_more title: VectorStoreSearchResponsePage - description: >- - Paginated response from searching a vector store. + description: Paginated response from searching a vector store. VersionInfo: type: object properties: @@ -9918,7 +8990,7 @@ components: description: Version number of the service additionalProperties: false required: - - version + - version title: VersionInfo description: Version information for the service. responses: @@ -9933,8 +9005,7 @@ components: 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 + description: The client has sent too many requests in a given amount of time content: application/json: schema: @@ -9942,11 +9013,9 @@ components: example: status: 429 title: Too Many Requests - detail: >- - You have exceeded the rate limit. Please try again later. + detail: You have exceeded the rate limit. Please try again later. InternalServerError500: - description: >- - The server encountered an unexpected error + description: The server encountered an unexpected error content: application/json: schema: @@ -9954,8 +9023,7 @@ components: example: status: 500 title: Internal Server Error - detail: >- - An unexpected error occurred. Our team has been notified. + detail: An unexpected error occurred. Our team has been notified. DefaultError: description: An unexpected error occurred content: @@ -9967,172 +9035,105 @@ components: title: Error detail: An unexpected error occurred security: - - Default: [] +- Default: [] tags: - - name: Agents - description: >- - APIs for creating and interacting with agentic systems. +- name: Agents + description: "APIs for creating and interacting with agentic systems.\n\n## Responses\ + \ API\n\nThe Responses API provides OpenAI-compatible functionality with enhanced\ + \ capabilities for dynamic, stateful interactions.\n\n> **\u2705 STABLE**: This\ + \ API is production-ready with backward compatibility guarantees. Recommended\ + \ for production applications.\n\n### \u2705 Supported Tools\n\nThe Responses\ + \ API supports the following tool types:\n\n- **`web_search`**: Search the web\ + \ for current information and real-time data\n- **`file_search`**: Search through\ + \ uploaded files and vector stores\n - Supports dynamic `vector_store_ids` per\ + \ call\n - Compatible with OpenAI file search patterns\n- **`function`**: Call\ + \ custom functions with JSON schema validation\n- **`mcp_tool`**: Model Context\ + \ Protocol integration\n\n### \u2705 Supported Fields & Features\n\n**Core Capabilities:**\n\ + - **Dynamic Configuration**: Switch models, vector stores, and tools per request\ + \ without pre-configuration\n- **Conversation Branching**: Use `previous_response_id`\ + \ to branch conversations and explore different paths\n- **Rich Annotations**:\ + \ Automatic file citations, URL citations, and container file citations\n- **Status\ + \ Tracking**: Monitor tool call execution status and handle failures gracefully\n\ + \n### \U0001F6A7 Work in Progress\n\n- Full real-time response streaming support\n\ + - `tool_choice` parameter\n- `max_tool_calls` parameter\n- Built-in tools (code\ + \ interpreter, containers API)\n- Safety & guardrails\n- `reasoning` capabilities\n\ + - `service_tier`\n- `logprobs`\n- `max_output_tokens`\n- `metadata` handling\n\ + - `instructions`\n- `incomplete_details`\n- `background`" + x-displayName: Agents +- name: Batches + description: "The API is designed to allow use of openai client libraries for seamless\ + \ integration.\n\nThis API provides the following extensions:\n - idempotent batch\ + \ creation\n\nNote: This API is currently under active development and may undergo\ + \ changes." + 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. +- name: Conversations + description: Protocol for conversation management operations. + x-displayName: Conversations +- name: Files + description: This API is used to upload documents that can be used with other Llama + Stack APIs. + x-displayName: Files +- name: Inference + description: 'Llama Stack Inference API for generating completions, chat completions, + and embeddings. - ## Responses API + 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. - The Responses API provides OpenAI-compatible functionality with enhanced capabilities - for dynamic, stateful interactions. + - Embedding models: these models generate embeddings to be used for semantic search. - - > **✅ STABLE**: This API is production-ready with backward compatibility guarantees. - Recommended for production applications. - - - ### ✅ Supported Tools - - - The Responses API supports the following tool types: - - - - **`web_search`**: Search the web for current information and real-time data - - - **`file_search`**: Search through uploaded files and vector stores - - Supports dynamic `vector_store_ids` per call - - Compatible with OpenAI file search patterns - - **`function`**: Call custom functions with JSON schema validation - - - **`mcp_tool`**: Model Context Protocol integration - - - ### ✅ Supported Fields & Features - - - **Core Capabilities:** - - - **Dynamic Configuration**: Switch models, vector stores, and tools per request - without pre-configuration - - - **Conversation Branching**: Use `previous_response_id` to branch conversations - and explore different paths - - - **Rich Annotations**: Automatic file citations, URL citations, and container - file citations - - - **Status Tracking**: Monitor tool call execution status and handle failures - gracefully - - - ### 🚧 Work in Progress - - - - Full real-time response streaming support - - - `tool_choice` parameter - - - `max_tool_calls` parameter - - - Built-in tools (code interpreter, containers API) - - - Safety & guardrails - - - `reasoning` capabilities - - - `service_tier` - - - `logprobs` - - - `max_output_tokens` - - - `metadata` handling - - - `instructions` - - - `incomplete_details` - - - `background` - x-displayName: Agents - - name: Batches - 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. - 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. - - name: Conversations - description: >- - Protocol for conversation management operations. - x-displayName: Conversations - - name: Files - description: >- - This API is used to upload documents that can be used with other Llama Stack - APIs. - x-displayName: Files - - name: Inference - 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. - x-displayName: Inference - - name: Inspect - description: >- - APIs for inspecting the Llama Stack service, including health status, available - API routes with methods and implementing providers. - x-displayName: Inspect - - name: Models - description: '' - - name: Prompts - description: >- - Protocol for prompt management operations. - x-displayName: Prompts - - name: Providers - description: >- - Providers API for inspecting, listing, and modifying providers and their configurations. - x-displayName: Providers - - name: Safety - description: OpenAI-compatible Moderations API. - x-displayName: Safety - - name: Scoring - description: '' - - name: ScoringFunctions - description: '' - - name: Shields - description: '' - - name: ToolGroups - description: '' - - name: ToolRuntime - description: '' - - name: VectorIO - description: '' + - Rerank models: these models reorder the documents based on their relevance to + a query.' + x-displayName: Inference +- name: Inspect + description: APIs for inspecting the Llama Stack service, including health status, + available API routes with methods and implementing providers. + x-displayName: Inspect +- name: Models + description: '' +- name: Prompts + description: Protocol for prompt management operations. + x-displayName: Prompts +- name: Providers + description: Providers API for inspecting, listing, and modifying providers and + their configurations. + x-displayName: Providers +- name: Safety + description: OpenAI-compatible Moderations API. + x-displayName: Safety +- name: Scoring + description: '' +- name: ScoringFunctions + description: '' +- name: Shields + description: '' +- name: ToolGroups + description: '' +- name: ToolRuntime + description: '' +- name: VectorIO + description: '' x-tagGroups: - - name: Operations - tags: - - Agents - - Batches - - Conversations - - Files - - Inference - - Inspect - - Models - - Prompts - - Providers - - Safety - - Scoring - - ScoringFunctions - - Shields - - ToolGroups - - ToolRuntime - - VectorIO +- name: Operations + tags: + - Agents + - Batches + - Conversations + - Files + - Inference + - Inspect + - Models + - Prompts + - Providers + - Safety + - Scoring + - ScoringFunctions + - Shields + - ToolGroups + - ToolRuntime + - VectorIO diff --git a/docs/static/stainless-llama-stack-spec.yaml b/docs/static/stainless-llama-stack-spec.yaml index 448b08908..97fceec2a 100644 --- a/docs/static/stainless-llama-stack-spec.yaml +++ b/docs/static/stainless-llama-stack-spec.yaml @@ -1,19 +1,15 @@ openapi: 3.1.0 info: - title: >- - Llama Stack Specification - Stable & Experimental APIs + title: Llama Stack Specification - Stable & Experimental APIs version: v1 - description: >- - This is the specification of the Llama Stack that provides - a set of endpoints and their corresponding interfaces that are - tailored to - best leverage Llama Models. - - **🔗 COMBINED**: This specification includes both stable production-ready APIs - and experimental pre-release APIs. Use stable APIs for production deployments - and experimental APIs for testing new features. + description: "This is the specification of the Llama Stack that provides\n \ + \ a set of endpoints and their corresponding interfaces that are\ntailored\ + \ to\n best leverage Llama Models.\n\n**\U0001F517 COMBINED**:\ + \ This specification includes both stable production-ready APIs and experimental\ + \ pre-release APIs. Use stable APIs for production deployments and experimental\ + \ APIs for testing new features." servers: - - url: http://any-hosted-llama-stack.com +- url: http://any-hosted-llama-stack.com paths: /v1/batches: get: @@ -27,32 +23,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches + - Batches summary: List all batches for the current user. description: List all batches for the current user. parameters: - - name: after - in: query - description: >- - A cursor for pagination; returns batches after this batch ID. - required: false - schema: - type: string - - name: limit - in: query - description: >- - Number of batches to return (default 20, max 100). - required: true - schema: - type: integer + - name: after + in: query + description: A cursor for pagination; returns batches after this batch ID. + required: false + schema: + type: string + - name: limit + in: query + description: Number of batches to return (default 20, max 100). + required: true + schema: + type: integer deprecated: false post: responses: @@ -65,19 +57,15 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches - summary: >- - Create a new batch for processing multiple API requests. - description: >- - Create a new batch for processing multiple API requests. + - Batches + summary: Create a new batch for processing multiple API requests. + description: Create a new batch for processing multiple API requests. parameters: [] requestBody: content: @@ -98,26 +86,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches - summary: >- - Retrieve information about a specific batch. - description: >- - Retrieve information about a specific batch. + - Batches + summary: Retrieve information about a specific batch. + description: Retrieve information about a specific batch. parameters: - - name: batch_id - in: path - description: The ID of the batch to retrieve. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the batch to retrieve. + required: true + schema: + type: string deprecated: false /v1/batches/{batch_id}/cancel: post: @@ -131,24 +115,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Batches + - Batches summary: Cancel a batch that is in progress. description: Cancel a batch that is in progress. parameters: - - name: batch_id - in: path - description: The ID of the batch to cancel. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the batch to cancel. + required: true + schema: + type: string deprecated: false /v1/chat/completions: get: @@ -162,46 +144,41 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: List chat completions. description: List chat completions. parameters: - - name: after - in: query - description: >- - The ID of the last chat completion to return. - required: false - schema: - type: string - - name: limit - in: query - description: >- - The maximum number of chat completions to return. - required: false - schema: - type: integer - - name: model - in: query - description: The model to filter by. - required: false - schema: - type: string - - name: order - in: query - description: >- - The order to sort the chat completions by: "asc" or "desc". Defaults to - "desc". - required: false - schema: - $ref: '#/components/schemas/Order' + - name: after + in: query + description: The ID of the last chat completion to return. + required: false + schema: + type: string + - name: limit + in: query + description: The maximum number of chat completions to return. + required: false + schema: + type: integer + - name: model + in: query + description: The model to filter by. + required: false + schema: + type: string + - name: order + in: query + description: 'The order to sort the chat completions by: "asc" or "desc". + Defaults to "desc".' + required: false + schema: + $ref: '#/components/schemas/Order' deprecated: false post: responses: @@ -211,26 +188,23 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletion' - - $ref: '#/components/schemas/OpenAIChatCompletionChunk' + - $ref: '#/components/schemas/OpenAIChatCompletion' + - $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Create chat completions. - description: >- - Create chat completions. + description: 'Create chat completions. Generate an OpenAI-compatible chat completion for the given messages using - the specified model. + the specified model.' parameters: [] requestBody: content: @@ -251,27 +225,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Get chat completion. - description: >- - Get chat completion. + description: 'Get chat completion. - Describe a chat completion by its ID. + Describe a chat completion by its ID.' parameters: - - name: completion_id - in: path - description: ID of the chat completion. - required: true - schema: - type: string + - name: completion_id + in: path + description: ID of the chat completion. + required: true + schema: + type: string deprecated: false /v1/completions: post: @@ -285,21 +256,18 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Create completion. - description: >- - Create completion. + description: 'Create completion. Generate an OpenAI-compatible completion for the given prompt using the specified - model. + model.' parameters: [] requestBody: content: @@ -320,20 +288,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Create a conversation. - description: >- - Create a conversation. + description: 'Create a conversation. - Create a conversation. + Create a conversation.' parameters: [] requestBody: content: @@ -354,27 +319,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Retrieve a conversation. - description: >- - Retrieve a conversation. + description: 'Retrieve a conversation. - Get a conversation with the given ID. + Get a conversation with the given ID.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string deprecated: false post: responses: @@ -387,27 +349,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Update a conversation. - description: >- - Update a conversation. + description: 'Update a conversation. - Update a conversation's metadata with the given ID. + Update a conversation''s metadata with the given ID.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string requestBody: content: application/json: @@ -426,27 +385,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Delete a conversation. - description: >- - Delete a conversation. + description: 'Delete a conversation. - Delete a conversation with the given ID. + Delete a conversation with the given ID.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string deprecated: false /v1/conversations/{conversation_id}/items: get: @@ -460,71 +416,64 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: List items. - description: >- - List items. + description: 'List items. - List items in the conversation. + List items in the conversation.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - - name: after - in: query - description: >- - An item ID to list items after, used in pagination. - required: false - schema: - type: string - - name: include - in: query - description: >- - Specify additional output data to include in the response. - required: false - schema: - type: array - items: - 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. - - name: limit - in: query - description: >- - A limit on the number of objects to be returned (1-100, default 20). - required: false - schema: - type: integer - - name: order - in: query - description: >- - The order to return items in (asc or desc, default desc). - required: false - schema: + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string + - name: after + in: query + description: An item ID to list items after, used in pagination. + required: false + schema: + type: string + - name: include + in: query + description: Specify additional output data to include in the response. + required: false + schema: + type: array + items: type: string enum: - - asc - - desc + - 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. + - name: limit + in: query + description: A limit on the number of objects to be returned (1-100, default + 20). + required: false + schema: + type: integer + - name: order + in: query + description: The order to return items in (asc or desc, default desc). + required: false + schema: + type: string + enum: + - asc + - desc deprecated: false post: responses: @@ -537,27 +486,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Create items. - description: >- - Create items. + description: 'Create items. - Create items in the conversation. + Create items in the conversation.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string requestBody: content: application/json: @@ -577,33 +523,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Retrieve an item. - description: >- - Retrieve an item. + description: 'Retrieve an item. - Retrieve a conversation item. + Retrieve a conversation item.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - - name: item_id - in: path - description: The item identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string + - name: item_id + in: path + description: The item identifier. + required: true + schema: + type: string deprecated: false delete: responses: @@ -616,40 +559,36 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Conversations + - Conversations summary: Delete an item. - description: >- - Delete an item. + description: 'Delete an item. - Delete a conversation item. + Delete a conversation item.' parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - - name: item_id - in: path - description: The item identifier. - required: true - schema: - type: string + - name: conversation_id + in: path + description: The conversation identifier. + required: true + schema: + type: string + - name: item_id + in: path + description: The item identifier. + required: true + schema: + type: string deprecated: false /v1/embeddings: post: responses: '200': - description: >- - An OpenAIEmbeddingsResponse containing the embeddings. + description: An OpenAIEmbeddingsResponse containing the embeddings. content: application/json: schema: @@ -657,21 +596,18 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference + - Inference summary: Create embeddings. - description: >- - Create embeddings. + description: 'Create embeddings. Generate OpenAI-compatible embeddings for the given input using the specified - model. + model.' parameters: [] requestBody: content: @@ -684,8 +620,7 @@ paths: get: responses: '200': - description: >- - An ListOpenAIFileResponse containing the list of files. + description: An ListOpenAIFileResponse containing the list of files. content: application/json: schema: @@ -693,60 +628,52 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: List files. - description: >- - List files. + description: 'List files. - Returns a list of files that belong to the user's organization. + Returns a list of files that belong to the user''s organization.' parameters: - - name: after - in: query - description: >- - A cursor for use in pagination. `after` is an object ID that defines your - place in the list. For instance, if you make a list request and receive - 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo - in order to fetch the next page of the list. - required: false - schema: - type: string - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 10,000, and the default is 10,000. - required: false - schema: - type: integer - - name: order - in: query - description: >- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending - order and `desc` for descending order. - required: false - schema: - $ref: '#/components/schemas/Order' - - name: purpose - in: query - description: >- - Only return files with the given purpose. - required: false - schema: - $ref: '#/components/schemas/OpenAIFilePurpose' + - name: after + in: query + description: A cursor for use in pagination. `after` is an object ID that + defines your place in the list. For instance, if you make a list request + and receive 100 objects, ending with obj_foo, your subsequent call can include + after=obj_foo in order to fetch the next page of the list. + required: false + schema: + type: string + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 10,000, and the default is 10,000. + required: false + schema: + type: integer + - name: order + in: query + description: Sort order by the `created_at` timestamp of the objects. `asc` + for ascending order and `desc` for descending order. + required: false + schema: + $ref: '#/components/schemas/Order' + - name: purpose + in: query + description: Only return files with the given purpose. + required: false + schema: + $ref: '#/components/schemas/OpenAIFilePurpose' deprecated: false post: responses: '200': - description: >- - An OpenAIFileObject representing the uploaded file. + description: An OpenAIFileObject representing the uploaded file. content: application/json: schema: @@ -754,18 +681,15 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Upload file. - description: >- - Upload file. + description: 'Upload file. Upload a file that can be used across various endpoints. @@ -776,7 +700,7 @@ paths: - purpose: The intended purpose of the uploaded file. - - expires_after: Optional form values describing expiration for the file. + - expires_after: Optional form values describing expiration for the file.' parameters: [] requestBody: content: @@ -792,16 +716,15 @@ paths: expires_after: $ref: '#/components/schemas/ExpiresAfter' required: - - file - - purpose + - file + - purpose required: true deprecated: false /v1/files/{file_id}: get: responses: '200': - description: >- - An OpenAIFileObject containing file information. + description: An OpenAIFileObject containing file information. content: application/json: schema: @@ -809,34 +732,29 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Retrieve file. - description: >- - Retrieve file. + description: 'Retrieve file. - Returns information about a specific file. + Returns information about a specific file.' parameters: - - name: file_id - in: path - description: >- - The ID of the file to use for this request. - required: true - schema: - type: string + - name: file_id + in: path + description: The ID of the file to use for this request. + required: true + schema: + type: string deprecated: false delete: responses: '200': - description: >- - An OpenAIFileDeleteResponse indicating successful deletion. + description: An OpenAIFileDeleteResponse indicating successful deletion. content: application/json: schema: @@ -844,32 +762,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Delete file. description: Delete file. parameters: - - name: file_id - in: path - description: >- - The ID of the file to use for this request. - required: true - schema: - type: string + - name: file_id + in: path + description: The ID of the file to use for this request. + required: true + schema: + type: string deprecated: false /v1/files/{file_id}/content: get: responses: '200': - description: >- - The raw file content as a binary response. + description: The raw file content as a binary response. content: application/json: schema: @@ -877,35 +791,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Files + - Files summary: Retrieve file content. - description: >- - Retrieve file content. + description: 'Retrieve file content. - Returns the contents of the specified file. + Returns the contents of the specified file.' parameters: - - name: file_id - in: path - description: >- - The ID of the file to use for this request. - required: true - schema: - type: string + - name: file_id + in: path + description: The ID of the file to use for this request. + required: true + schema: + type: string deprecated: false /v1/health: get: responses: '200': - description: >- - Health information indicating if the service is operational. + description: Health information indicating if the service is operational. content: application/json: schema: @@ -913,28 +822,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inspect + - Inspect summary: Get health status. - description: >- - Get health status. + description: 'Get health status. - Get the current health status of the service. + Get the current health status of the service.' parameters: [] deprecated: false /v1/inspect/routes: get: responses: '200': - description: >- - Response containing information about all available routes. + description: Response containing information about all available routes. content: application/json: schema: @@ -942,36 +847,32 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inspect + - Inspect summary: List routes. - description: >- - List routes. + description: 'List routes. - List all available API routes with their methods and implementing providers. + List all available API routes with their methods and implementing providers.' parameters: - - name: api_filter - in: query - description: >- - Optional filter to control which routes are returned. Can be an API level - ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at that level, - or 'deprecated' to show deprecated routes across all levels. If not specified, - returns only non-deprecated v1 routes. - required: false - schema: - type: string - enum: - - v1 - - v1alpha - - v1beta - - deprecated + - name: api_filter + in: query + description: Optional filter to control which routes are returned. Can be + an API level ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at + that level, or 'deprecated' to show deprecated routes across all levels. + If not specified, returns only non-deprecated v1 routes. + required: false + schema: + type: string + enum: + - v1 + - v1alpha + - v1beta + - deprecated deprecated: false /v1/models: get: @@ -985,15 +886,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: List models using the OpenAI API. description: List models using the OpenAI API. parameters: [] @@ -1009,20 +908,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: Register model. - description: >- - Register model. + description: 'Register model. - Register a model. + Register a model.' parameters: [] requestBody: content: @@ -1043,27 +939,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: Get model. - description: >- - Get model. + description: 'Get model. - Get a model by its identifier. + Get a model by its identifier.' parameters: - - name: model_id - in: path - description: The identifier of the model to get. - required: true - schema: - type: string + - name: model_id + in: path + description: The identifier of the model to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1072,28 +965,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Models + - Models summary: Unregister model. - description: >- - Unregister model. + description: 'Unregister model. - Unregister a model. + Unregister a model.' parameters: - - name: model_id - in: path - description: >- - The identifier of the model to unregister. - required: true - schema: - type: string + - name: model_id + in: path + description: The identifier of the model to unregister. + required: true + schema: + type: string deprecated: false /v1/moderations: post: @@ -1107,20 +996,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Safety + - Safety summary: Create moderation. - description: >- - Create moderation. + description: 'Create moderation. - Classifies if text and/or image inputs are potentially harmful. + Classifies if text and/or image inputs are potentially harmful.' parameters: [] requestBody: content: @@ -1133,8 +1019,7 @@ paths: get: responses: '200': - description: >- - A ListPromptsResponse containing all prompts. + description: A ListPromptsResponse containing all prompts. content: application/json: schema: @@ -1142,15 +1027,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: List all prompts. description: List all prompts. parameters: [] @@ -1166,20 +1049,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Create prompt. - description: >- - Create prompt. + description: 'Create prompt. - Create a new prompt. + Create a new prompt.' parameters: [] requestBody: content: @@ -1200,40 +1080,35 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Get prompt. - description: >- - Get prompt. + description: 'Get prompt. - Get a prompt by its identifier and optional version. + Get a prompt by its identifier and optional version.' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt to get. - required: true - schema: - type: string - - name: version - in: query - description: >- - The version of the prompt to get (defaults to latest). - required: false - schema: - type: integer + - name: prompt_id + in: path + description: The identifier of the prompt to get. + required: true + schema: + type: string + - name: version + in: query + description: The version of the prompt to get (defaults to latest). + required: false + schema: + type: integer deprecated: false post: responses: '200': - description: >- - The updated Prompt resource with incremented version. + description: The updated Prompt resource with incremented version. content: application/json: schema: @@ -1241,27 +1116,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Update prompt. - description: >- - Update prompt. + description: 'Update prompt. - Update an existing prompt (increments version). + Update an existing prompt (increments version).' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt to update. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt to update. + required: true + schema: + type: string requestBody: content: application/json: @@ -1276,34 +1148,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Delete prompt. - description: >- - Delete prompt. + description: 'Delete prompt. - Delete a prompt. + Delete a prompt.' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt to delete. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt to delete. + required: true + schema: + type: string deprecated: false /v1/prompts/{prompt_id}/set-default-version: post: responses: '200': - description: >- - The prompt with the specified version now set as default. + description: The prompt with the specified version now set as default. content: application/json: schema: @@ -1311,27 +1179,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: Set prompt version. - description: >- - Set prompt version. + description: 'Set prompt version. - Set which version of a prompt should be the default in get_prompt (latest). + Set which version of a prompt should be the default in get_prompt (latest).' parameters: - - name: prompt_id - in: path - description: The identifier of the prompt. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt. + required: true + schema: + type: string requestBody: content: application/json: @@ -1343,8 +1208,7 @@ paths: get: responses: '200': - description: >- - A ListPromptsResponse containing all versions of the prompt. + description: A ListPromptsResponse containing all versions of the prompt. content: application/json: schema: @@ -1352,35 +1216,30 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Prompts + - Prompts summary: List prompt versions. - description: >- - List prompt versions. + description: 'List prompt versions. - List all versions of a specific prompt. + List all versions of a specific prompt.' parameters: - - name: prompt_id - in: path - description: >- - The identifier of the prompt to list versions for. - required: true - schema: - type: string + - name: prompt_id + in: path + description: The identifier of the prompt to list versions for. + required: true + schema: + type: string deprecated: false /v1/providers: get: responses: '200': - description: >- - A ListProvidersResponse containing information about all providers. + description: A ListProvidersResponse containing information about all providers. content: application/json: schema: @@ -1388,28 +1247,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Providers + - Providers summary: List providers. - description: >- - List providers. + description: 'List providers. - List all available providers. + List all available providers.' parameters: [] deprecated: false /v1/providers/{provider_id}: get: responses: '200': - description: >- - A ProviderInfo object containing the provider's details. + description: A ProviderInfo object containing the provider's details. content: application/json: schema: @@ -1417,27 +1272,24 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Providers + - Providers summary: Get provider. - description: >- - Get provider. + description: 'Get provider. - Get detailed information about a specific provider. + Get detailed information about a specific provider.' parameters: - - name: provider_id - in: path - description: The ID of the provider to inspect. - required: true - schema: - type: string + - name: provider_id + in: path + description: The ID of the provider to inspect. + required: true + schema: + type: string deprecated: false /v1/responses: get: @@ -1451,43 +1303,41 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: List all responses. description: List all responses. parameters: - - name: after - in: query - description: The ID of the last response to return. - required: false - schema: - type: string - - name: limit - in: query - description: The number of responses to return. - required: false - schema: - type: integer - - name: model - in: query - description: The model to filter responses by. - required: false - schema: - type: string - - name: order - in: query - description: >- - The order to sort responses by when sorted by created_at ('asc' or 'desc'). - required: false - schema: - $ref: '#/components/schemas/Order' + - name: after + in: query + description: The ID of the last response to return. + required: false + schema: + type: string + - name: limit + in: query + description: The number of responses to return. + required: false + schema: + type: integer + - name: model + in: query + description: The model to filter responses by. + required: false + schema: + type: string + - name: order + in: query + description: The order to sort responses by when sorted by created_at ('asc' + or 'desc'). + required: false + schema: + $ref: '#/components/schemas/Order' deprecated: false post: responses: @@ -1503,15 +1353,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: Create a model response. description: Create a model response. parameters: [] @@ -1523,17 +1371,16 @@ paths: required: true deprecated: false x-llama-stack-extra-body-params: - - name: guardrails - schema: - type: array - items: - oneOf: - - type: string - - $ref: '#/components/schemas/ResponseGuardrailSpec' - description: >- - List of guardrails to apply during response generation. Guardrails provide - safety and content moderation. - required: false + - name: guardrails + schema: + type: array + items: + oneOf: + - type: string + - $ref: '#/components/schemas/ResponseGuardrailSpec' + description: List of guardrails to apply during response generation. Guardrails + provide safety and content moderation. + required: false /v1/responses/{response_id}: get: responses: @@ -1546,25 +1393,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: Get a model response. description: Get a model response. parameters: - - name: response_id - in: path - description: >- - The ID of the OpenAI response to retrieve. - required: true - schema: - type: string + - name: response_id + in: path + description: The ID of the OpenAI response to retrieve. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1577,24 +1421,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: Delete a response. description: Delete a response. parameters: - - name: response_id - in: path - description: The ID of the OpenAI response to delete. - required: true - schema: - type: string + - name: response_id + in: path + description: The ID of the OpenAI response to delete. + required: true + schema: + type: string deprecated: false /v1/responses/{response_id}/input_items: get: @@ -1608,63 +1450,55 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Agents + - Agents summary: List input items. description: List input items. parameters: - - name: response_id - in: path - description: >- - The ID of the response to retrieve input items for. - required: true - schema: + - name: response_id + in: path + description: The ID of the response to retrieve input items for. + required: true + schema: + type: string + - name: after + in: query + description: An item ID to list items after, used for pagination. + required: false + schema: + type: string + - name: before + in: query + description: An item ID to list items before, used for pagination. + required: false + schema: + type: string + - name: include + in: query + description: Additional fields to include in the response. + required: false + schema: + type: array + items: type: string - - name: after - in: query - description: >- - An item ID to list items after, used for pagination. - required: false - schema: - type: string - - name: before - in: query - description: >- - An item ID to list items before, used for pagination. - required: false - schema: - type: string - - name: include - in: query - description: >- - Additional fields to include in the response. - required: false - schema: - type: array - items: - type: string - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - The order to return the input items in. Default is desc. - required: false - schema: - $ref: '#/components/schemas/Order' + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: The order to return the input items in. Default is desc. + required: false + schema: + $ref: '#/components/schemas/Order' deprecated: false /v1/safety/run-shield: post: @@ -1678,20 +1512,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Safety + - Safety summary: Run shield. - description: >- - Run shield. + description: 'Run shield. - Run a shield. + Run a shield.' parameters: [] requestBody: content: @@ -1712,15 +1543,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: List all scoring functions. description: List all scoring functions. parameters: [] @@ -1732,15 +1561,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: Register a scoring function. description: Register a scoring function. parameters: [] @@ -1763,24 +1590,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: Get a scoring function by its ID. description: Get a scoring function by its ID. parameters: - - name: scoring_fn_id - in: path - description: The ID of the scoring function to get. - required: true - schema: - type: string + - name: scoring_fn_id + in: path + description: The ID of the scoring function to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1789,32 +1614,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ScoringFunctions + - ScoringFunctions summary: Unregister a scoring function. description: Unregister a scoring function. parameters: - - name: scoring_fn_id - in: path - description: >- - The ID of the scoring function to unregister. - required: true - schema: - type: string + - name: scoring_fn_id + in: path + description: The ID of the scoring function to unregister. + required: true + schema: + type: string deprecated: false /v1/scoring/score: post: responses: '200': - description: >- - A ScoreResponse object containing rows and aggregated results. + description: A ScoreResponse object containing rows and aggregated results. content: application/json: schema: @@ -1822,15 +1643,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Scoring + - Scoring summary: Score a list of rows. description: Score a list of rows. parameters: [] @@ -1853,15 +1672,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Scoring + - Scoring summary: Score a batch of rows. description: Score a batch of rows. parameters: [] @@ -1884,15 +1701,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: List all shields. description: List all shields. parameters: [] @@ -1908,15 +1723,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: Register a shield. description: Register a shield. parameters: [] @@ -1939,24 +1752,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: Get a shield by its identifier. description: Get a shield by its identifier. parameters: - - name: identifier - in: path - description: The identifier of the shield to get. - required: true - schema: - type: string + - name: identifier + in: path + description: The identifier of the shield to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -1965,25 +1776,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Shields + - Shields summary: Unregister a shield. description: Unregister a shield. parameters: - - name: identifier - in: path - description: >- - The identifier of the shield to unregister. - required: true - schema: - type: string + - name: identifier + in: path + description: The identifier of the shield to unregister. + required: true + schema: + type: string deprecated: false /v1/tool-runtime/invoke: post: @@ -1997,15 +1805,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolRuntime + - ToolRuntime summary: Run a tool with the given arguments. description: Run a tool with the given arguments. parameters: [] @@ -2028,32 +1834,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolRuntime + - ToolRuntime summary: List all tools in the runtime. description: List all tools in the runtime. parameters: - - name: tool_group_id - in: query - description: >- - The ID of the tool group to list tools for. - required: false - schema: - type: string - - name: mcp_endpoint - in: query - description: >- - The MCP endpoint to use for the tool group. - required: false - schema: - $ref: '#/components/schemas/URL' + - name: tool_group_id + in: query + description: The ID of the tool group to list tools for. + required: false + schema: + type: string + - name: mcp_endpoint + in: query + description: The MCP endpoint to use for the tool group. + required: false + schema: + $ref: '#/components/schemas/URL' deprecated: false /v1/toolgroups: get: @@ -2067,15 +1869,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: List tool groups with optional provider. description: List tool groups with optional provider. parameters: [] @@ -2087,15 +1887,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Register a tool group. description: Register a tool group. parameters: [] @@ -2118,24 +1916,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Get a tool group by its ID. description: Get a tool group by its ID. parameters: - - name: toolgroup_id - in: path - description: The ID of the tool group to get. - required: true - schema: - type: string + - name: toolgroup_id + in: path + description: The ID of the tool group to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -2144,24 +1940,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Unregister a tool group. description: Unregister a tool group. parameters: - - name: toolgroup_id - in: path - description: The ID of the tool group to unregister. - required: true - schema: - type: string + - name: toolgroup_id + in: path + description: The ID of the tool group to unregister. + required: true + schema: + type: string deprecated: false /v1/tools: get: @@ -2175,25 +1969,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: List tools with optional tool group. description: List tools with optional tool group. parameters: - - name: toolgroup_id - in: query - description: >- - The ID of the tool group to list tools for. - required: false - schema: - type: string + - name: toolgroup_id + in: query + description: The ID of the tool group to list tools for. + required: false + schema: + type: string deprecated: false /v1/tools/{tool_name}: get: @@ -2207,24 +1998,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - ToolGroups + - ToolGroups summary: Get a tool by its name. description: Get a tool by its name. parameters: - - name: tool_name - in: path - description: The name of the tool to get. - required: true - schema: - type: string + - name: tool_name + in: path + description: The name of the tool to get. + required: true + schema: + type: string deprecated: false /v1/vector-io/insert: post: @@ -2234,15 +2023,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Insert chunks into a vector database. description: Insert chunks into a vector database. parameters: [] @@ -2265,15 +2052,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Query chunks from a vector database. description: Query chunks from a vector database. parameters: [] @@ -2288,8 +2073,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreListResponse containing the list of vector stores. + description: A VectorStoreListResponse containing the list of vector stores. content: application/json: schema: @@ -2297,56 +2081,49 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Returns a list of vector stores. description: Returns a list of vector stores. parameters: - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending - order and `desc` for descending order. - required: false - schema: - type: string - - name: after - in: query - description: >- - A cursor for use in pagination. `after` is an object ID that defines your - place in the list. - required: false - schema: - type: string - - name: before - in: query - description: >- - A cursor for use in pagination. `before` is an object ID that defines - your place in the list. - required: false - schema: - type: string + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: Sort order by the `created_at` timestamp of the objects. `asc` + for ascending order and `desc` for descending order. + required: false + schema: + type: string + - name: after + in: query + description: A cursor for use in pagination. `after` is an object ID that + defines your place in the list. + required: false + schema: + type: string + - name: before + in: query + description: A cursor for use in pagination. `before` is an object ID that + defines your place in the list. + required: false + schema: + type: string deprecated: false post: responses: '200': - description: >- - A VectorStoreObject representing the created vector store. + description: A VectorStoreObject representing the created vector store. content: application/json: schema: @@ -2354,20 +2131,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Creates a vector store. - description: >- - Creates a vector store. + description: 'Creates a vector store. - Generate an OpenAI-compatible vector store with the given parameters. + Generate an OpenAI-compatible vector store with the given parameters.' parameters: [] requestBody: content: @@ -2380,8 +2154,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreObject representing the vector store. + description: A VectorStoreObject representing the vector store. content: application/json: schema: @@ -2389,30 +2162,27 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Retrieves a vector store. description: Retrieves a vector store. parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to retrieve. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to retrieve. + required: true + schema: + type: string deprecated: false post: responses: '200': - description: >- - A VectorStoreObject representing the updated vector store. + description: A VectorStoreObject representing the updated vector store. content: application/json: schema: @@ -2420,24 +2190,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Updates a vector store. description: Updates a vector store. parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to update. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to update. + required: true + schema: + type: string requestBody: content: application/json: @@ -2448,8 +2216,7 @@ paths: delete: responses: '200': - description: >- - A VectorStoreDeleteResponse indicating the deletion status. + description: A VectorStoreDeleteResponse indicating the deletion status. content: application/json: schema: @@ -2457,31 +2224,29 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Delete a vector store. description: Delete a vector store. parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to delete. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to delete. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/file_batches: post: responses: '200': - description: >- - A VectorStoreFileBatchObject representing the created file batch. + description: A VectorStoreFileBatchObject representing the created file + batch. content: application/json: schema: @@ -2489,29 +2254,25 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Create a vector store file batch. - description: >- - Create a vector store file batch. + description: 'Create a vector store file batch. Generate an OpenAI-compatible vector store file batch for the given vector - store. + store.' parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store to create the file batch for. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to create the file batch for. + required: true + schema: + type: string requestBody: content: application/json: @@ -2523,8 +2284,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreFileBatchObject representing the file batch. + description: A VectorStoreFileBatchObject representing the file batch. content: application/json: schema: @@ -2532,38 +2292,35 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Retrieve a vector store file batch. description: Retrieve a vector store file batch. parameters: - - name: batch_id - in: path - description: The ID of the file batch to retrieve. - required: true - schema: - type: string - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file batch. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the file batch to retrieve. + required: true + schema: + type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file batch. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: post: responses: '200': - description: >- - A VectorStoreFileBatchObject representing the cancelled file batch. + description: A VectorStoreFileBatchObject representing the cancelled file + batch. content: application/json: schema: @@ -2571,39 +2328,35 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Cancels a vector store file batch. description: Cancels a vector store file batch. parameters: - - name: batch_id - in: path - description: The ID of the file batch to cancel. - required: true - schema: - type: string - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file batch. - required: true - schema: - type: string + - name: batch_id + in: path + description: The ID of the file batch to cancel. + required: true + schema: + type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file batch. + required: true + schema: + type: string deprecated: false /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. + description: A VectorStoreFilesListInBatchResponse containing the list of + files in the batch. content: application/json: schema: @@ -2611,80 +2364,69 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO - summary: >- - Returns a list of vector store files in a batch. - description: >- - Returns a list of vector store files in a batch. + - VectorIO + summary: Returns a list of vector store files in a batch. + description: Returns a list of vector store files in a batch. parameters: - - name: batch_id - in: path - description: >- - The ID of the file batch to list files from. - required: true - schema: - type: string - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file batch. - required: true - schema: - type: string - - name: after - in: query - description: >- - A cursor for use in pagination. `after` is an object ID that defines your - place in the list. - required: false - schema: - type: string - - name: before - in: query - description: >- - A cursor for use in pagination. `before` is an object ID that defines - your place in the list. - required: false - schema: - type: string - - name: filter - in: query - description: >- - Filter by file status. One of in_progress, completed, failed, cancelled. - required: false - schema: - type: string - - name: limit - in: query - description: >- - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - Sort order by the `created_at` timestamp of the objects. `asc` for ascending - order and `desc` for descending order. - required: false - schema: - type: string + - name: batch_id + in: path + description: The ID of the file batch to list files from. + required: true + schema: + type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file batch. + required: true + schema: + type: string + - name: after + in: query + description: A cursor for use in pagination. `after` is an object ID that + defines your place in the list. + required: false + schema: + type: string + - name: before + in: query + description: A cursor for use in pagination. `before` is an object ID that + defines your place in the list. + required: false + schema: + type: string + - name: filter + in: query + description: Filter by file status. One of in_progress, completed, failed, + cancelled. + required: false + schema: + type: string + - name: limit + in: query + description: A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: Sort order by the `created_at` timestamp of the objects. `asc` + for ascending order and `desc` for descending order. + required: false + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/files: get: responses: '200': - description: >- - A VectorStoreListFilesResponse containing the list of files. + description: A VectorStoreListFilesResponse containing the list of files. content: application/json: schema: @@ -2692,71 +2434,62 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: List files in a vector store. description: List files in a vector store. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store to list files from. - required: true - schema: - type: string - - name: limit - in: query - description: >- - (Optional) A limit on the number of objects to be returned. Limit can - range between 1 and 100, and the default is 20. - required: false - schema: - type: integer - - name: order - in: query - description: >- - (Optional) Sort order by the `created_at` timestamp of the objects. `asc` - for ascending order and `desc` for descending order. - required: false - schema: - type: string - - name: after - in: query - description: >- - (Optional) A cursor for use in pagination. `after` is an object ID that - defines your place in the list. - required: false - schema: - type: string - - name: before - in: query - description: >- - (Optional) A cursor for use in pagination. `before` is an object ID that - defines your place in the list. - required: false - schema: - type: string - - name: filter - in: query - description: >- - (Optional) Filter by file status to only return files with the specified - status. - required: false - schema: - $ref: '#/components/schemas/VectorStoreFileStatus' + - name: vector_store_id + in: path + description: The ID of the vector store to list files from. + required: true + schema: + type: string + - name: limit + in: query + description: (Optional) A limit on the number of objects to be returned. Limit + can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + - name: order + in: query + description: (Optional) Sort order by the `created_at` timestamp of the objects. + `asc` for ascending order and `desc` for descending order. + required: false + schema: + type: string + - name: after + in: query + description: (Optional) A cursor for use in pagination. `after` is an object + ID that defines your place in the list. + required: false + schema: + type: string + - name: before + in: query + description: (Optional) A cursor for use in pagination. `before` is an object + ID that defines your place in the list. + required: false + schema: + type: string + - name: filter + in: query + description: (Optional) Filter by file status to only return files with the + specified status. + required: false + schema: + $ref: '#/components/schemas/VectorStoreFileStatus' deprecated: false post: responses: '200': - description: >- - A VectorStoreFileObject representing the attached file. + description: A VectorStoreFileObject representing the attached file. content: application/json: schema: @@ -2764,25 +2497,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Attach a file to a vector store. description: Attach a file to a vector store. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store to attach the file to. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to attach the file to. + required: true + schema: + type: string requestBody: content: application/json: @@ -2794,8 +2524,7 @@ paths: get: responses: '200': - description: >- - A VectorStoreFileObject representing the file. + description: A VectorStoreFileObject representing the file. content: application/json: schema: @@ -2803,37 +2532,33 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Retrieves a vector store file. description: Retrieves a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to retrieve. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to retrieve. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to retrieve. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to retrieve. + required: true + schema: + type: string deprecated: false post: responses: '200': - description: >- - A VectorStoreFileObject representing the updated file. + description: A VectorStoreFileObject representing the updated file. content: application/json: schema: @@ -2841,31 +2566,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Updates a vector store file. description: Updates a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to update. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to update. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to update. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to update. + required: true + schema: + type: string requestBody: content: application/json: @@ -2876,8 +2598,7 @@ paths: delete: responses: '200': - description: >- - A VectorStoreFileDeleteResponse indicating the deletion status. + description: A VectorStoreFileDeleteResponse indicating the deletion status. content: application/json: schema: @@ -2885,79 +2606,69 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Delete a vector store file. description: Delete a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to delete. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to delete. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to delete. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to delete. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: responses: '200': - description: >- - A list of InterleavedContent representing the file contents. + description: A list of InterleavedContent representing the file contents. content: application/json: schema: - $ref: '#/components/schemas/VectorStoreFileContentsResponse' + $ref: '#/components/schemas/VectorStoreFileContentResponse' '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO - summary: >- - Retrieves the contents of a vector store file. - description: >- - Retrieves the contents of a vector store file. + - VectorIO + summary: Retrieves the contents of a vector store file. + description: Retrieves the contents of a vector store file. parameters: - - name: vector_store_id - in: path - description: >- - The ID of the vector store containing the file to retrieve. - required: true - schema: - type: string - - name: file_id - in: path - description: The ID of the file to retrieve. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store containing the file to retrieve. + required: true + schema: + type: string + - name: file_id + in: path + description: The ID of the file to retrieve. + required: true + schema: + type: string deprecated: false /v1/vector_stores/{vector_store_id}/search: post: responses: '200': - description: >- - A VectorStoreSearchResponse containing the search results. + description: A VectorStoreSearchResponse containing the search results. content: application/json: schema: @@ -2965,28 +2676,25 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - VectorIO + - VectorIO summary: Search for chunks in a vector store. - description: >- - Search for chunks in a 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. + file attribute filters.' parameters: - - name: vector_store_id - in: path - description: The ID of the vector store to search. - required: true - schema: - type: string + - name: vector_store_id + in: path + description: The ID of the vector store to search. + required: true + schema: + type: string requestBody: content: application/json: @@ -2998,8 +2706,7 @@ paths: get: responses: '200': - description: >- - Version information containing the service version number. + description: Version information containing the service version number. content: application/json: schema: @@ -3007,20 +2714,17 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inspect + - Inspect summary: Get version. - description: >- - Get version. + description: 'Get version. - Get the version of the service. + Get the version of the service.' parameters: [] deprecated: false /v1beta/datasetio/append-rows/{dataset_id}: @@ -3031,25 +2735,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - DatasetIO + - DatasetIO summary: Append rows to a dataset. description: Append rows to a dataset. parameters: - - name: dataset_id - in: path - description: >- - The ID of the dataset to append the rows to. - required: true - schema: - type: string + - name: dataset_id + in: path + description: The ID of the dataset to append the rows to. + required: true + schema: + type: string requestBody: content: application/json: @@ -3069,19 +2770,15 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - DatasetIO - summary: >- - Get a paginated list of rows from a dataset. - description: >- - Get a paginated list of rows from a dataset. + - DatasetIO + summary: Get a paginated list of rows from a dataset. + description: 'Get a paginated list of rows from a dataset. Uses offset-based pagination where: @@ -3094,28 +2791,27 @@ paths: - data: List of items for the current page. - - has_more: Whether there are more items available after this set. + - has_more: Whether there are more items available after this set.' parameters: - - name: dataset_id - in: path - description: >- - The ID of the dataset to get the rows from. - required: true - schema: - type: string - - name: start_index - in: query - description: >- - Index into dataset for the first row to get. Get all rows if None. - required: false - schema: - type: integer - - name: limit - in: query - description: The number of rows to get. - required: false - schema: - type: integer + - name: dataset_id + in: path + description: The ID of the dataset to get the rows from. + required: true + schema: + type: string + - name: start_index + in: query + description: Index into dataset for the first row to get. Get all rows if + None. + required: false + schema: + type: integer + - name: limit + in: query + description: The number of rows to get. + required: false + schema: + type: integer deprecated: false /v1beta/datasets: get: @@ -3129,15 +2825,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Datasets + - Datasets summary: List all datasets. description: List all datasets. parameters: [] @@ -3153,15 +2847,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Datasets + - Datasets summary: Register a new dataset. description: Register a new dataset. parameters: [] @@ -3184,24 +2876,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Datasets + - Datasets summary: Get a dataset by its ID. description: Get a dataset by its ID. parameters: - - name: dataset_id - in: path - description: The ID of the dataset to get. - required: true - schema: - type: string + - name: dataset_id + in: path + description: The ID of the dataset to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -3210,24 +2900,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Datasets + - Datasets summary: Unregister a dataset by its ID. description: Unregister a dataset by its ID. parameters: - - name: dataset_id - in: path - description: The ID of the dataset to unregister. - required: true - schema: - type: string + - name: dataset_id + in: path + description: The ID of the dataset to unregister. + required: true + schema: + type: string deprecated: false /v1alpha/eval/benchmarks: get: @@ -3241,15 +2929,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Benchmarks + - Benchmarks summary: List all benchmarks. description: List all benchmarks. parameters: [] @@ -3261,15 +2947,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Benchmarks + - Benchmarks summary: Register a benchmark. description: Register a benchmark. parameters: [] @@ -3292,24 +2976,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Benchmarks + - Benchmarks summary: Get a benchmark by its ID. description: Get a benchmark by its ID. parameters: - - name: benchmark_id - in: path - description: The ID of the benchmark to get. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to get. + required: true + schema: + type: string deprecated: false delete: responses: @@ -3318,31 +3000,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Benchmarks + - Benchmarks summary: Unregister a benchmark. description: Unregister a benchmark. parameters: - - name: benchmark_id - in: path - description: The ID of the benchmark to unregister. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to unregister. + required: true + schema: + type: string deprecated: false /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: post: responses: '200': - description: >- - EvaluateResponse object containing generations and scores. + description: EvaluateResponse object containing generations and scores. content: application/json: schema: @@ -3350,25 +3029,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Eval + - Eval summary: Evaluate a list of rows on a benchmark. description: Evaluate a list of rows on a benchmark. parameters: - - name: benchmark_id - in: path - description: >- - The ID of the benchmark to run the evaluation on. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to run the evaluation on. + required: true + schema: + type: string requestBody: content: application/json: @@ -3380,8 +3056,7 @@ paths: post: responses: '200': - description: >- - The job that was created to run the evaluation. + description: The job that was created to run the evaluation. content: application/json: schema: @@ -3389,25 +3064,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Eval + - Eval summary: Run an evaluation on a benchmark. description: Run an evaluation on a benchmark. parameters: - - name: benchmark_id - in: path - description: >- - The ID of the benchmark to run the evaluation on. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to run the evaluation on. + required: true + schema: + type: string requestBody: content: application/json: @@ -3427,31 +3099,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Eval + - Eval summary: Get the status of a job. description: Get the status of a job. parameters: - - name: benchmark_id - in: path - description: >- - The ID of the benchmark to run the evaluation on. - required: true - schema: - type: string - - name: job_id - in: path - description: The ID of the job to get the status of. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to run the evaluation on. + required: true + schema: + type: string + - name: job_id + in: path + description: The ID of the job to get the status of. + required: true + schema: + type: string deprecated: false delete: responses: @@ -3460,31 +3129,28 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Eval + - Eval summary: Cancel a job. description: Cancel a job. parameters: - - name: benchmark_id - in: path - description: >- - The ID of the benchmark to run the evaluation on. - required: true - schema: - type: string - - name: job_id - in: path - description: The ID of the job to cancel. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to run the evaluation on. + required: true + schema: + type: string + - name: job_id + in: path + description: The ID of the job to cancel. + required: true + schema: + type: string deprecated: false /v1alpha/eval/benchmarks/{benchmark_id}/jobs/{job_id}/result: get: @@ -3498,38 +3164,34 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Eval + - Eval summary: Get the result of a job. description: Get the result of a job. parameters: - - name: benchmark_id - in: path - description: >- - The ID of the benchmark to run the evaluation on. - required: true - schema: - type: string - - name: job_id - in: path - description: The ID of the job to get the result of. - required: true - schema: - type: string + - name: benchmark_id + in: path + description: The ID of the benchmark to run the evaluation on. + required: true + schema: + type: string + - name: job_id + in: path + description: The ID of the job to get the result of. + required: true + schema: + type: string deprecated: false /v1alpha/inference/rerank: post: responses: '200': - description: >- - RerankResponse with indices sorted by relevance score (descending). + description: RerankResponse with indices sorted by relevance score (descending). content: application/json: schema: @@ -3537,19 +3199,15 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - Inference - summary: >- - Rerank a list of documents based on their relevance to a query. - description: >- - Rerank a list of documents based on their relevance to a query. + - Inference + summary: Rerank a list of documents based on their relevance to a query. + description: Rerank a list of documents based on their relevance to a query. parameters: [] requestBody: content: @@ -3570,25 +3228,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - PostTraining (Coming Soon) + - PostTraining (Coming Soon) summary: Get the artifacts of a training job. description: Get the artifacts of a training job. parameters: - - name: job_uuid - in: query - description: >- - The UUID of the job to get the artifacts of. - required: true - schema: - type: string + - name: job_uuid + in: query + description: The UUID of the job to get the artifacts of. + required: true + schema: + type: string deprecated: false /v1alpha/post-training/job/cancel: post: @@ -3598,15 +3253,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - PostTraining (Coming Soon) + - PostTraining (Coming Soon) summary: Cancel a training job. description: Cancel a training job. parameters: [] @@ -3629,25 +3282,22 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - PostTraining (Coming Soon) + - PostTraining (Coming Soon) summary: Get the status of a training job. description: Get the status of a training job. parameters: - - name: job_uuid - in: query - description: >- - The UUID of the job to get the status of. - required: true - schema: - type: string + - name: job_uuid + in: query + description: The UUID of the job to get the status of. + required: true + schema: + type: string deprecated: false /v1alpha/post-training/jobs: get: @@ -3661,15 +3311,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - PostTraining (Coming Soon) + - PostTraining (Coming Soon) summary: Get all training jobs. description: Get all training jobs. parameters: [] @@ -3686,15 +3334,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - PostTraining (Coming Soon) + - PostTraining (Coming Soon) summary: Run preference optimization of a model. description: Run preference optimization of a model. parameters: [] @@ -3717,15 +3363,13 @@ paths: '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + $ref: '#/components/responses/InternalServerError500' default: $ref: '#/components/responses/DefaultError' tags: - - PostTraining (Coming Soon) + - PostTraining (Coming Soon) summary: Run supervised fine-tuning of a model. description: Run supervised fine-tuning of a model. parameters: [] @@ -3736,8 +3380,7 @@ paths: $ref: '#/components/schemas/SupervisedFineTuneRequest' required: true deprecated: false -jsonSchemaDialect: >- - https://json-schema.org/draft/2020-12/schema +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema components: schemas: Error: @@ -3748,26 +3391,22 @@ components: description: HTTP status code title: type: string - description: >- - Error title, a short summary of the error which is invariant for an error - type + description: Error title, a short summary of the error which is invariant + for an error type detail: type: string - description: >- - Error detail, a longer human-readable description of the error + description: Error detail, a longer human-readable description of the error instance: type: string - description: >- - (Optional) A URL which can be used to retrieve more information about - the specific occurrence of the error + description: (Optional) A URL which can be used to retrieve more information + about the specific occurrence of the error additionalProperties: false required: - - status - - title - - detail + - status + - title + - detail title: Error - description: >- - Error response from the API. Roughly follows RFC 7807. + description: Error response from the API. Roughly follows RFC 7807. ListBatchesResponse: type: object properties: @@ -3796,14 +3435,14 @@ components: status: type: string enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled cancelled_at: type: integer cancelling_at: @@ -3863,9 +3502,9 @@ components: type: integer additionalProperties: false required: - - completed - - failed - - total + - completed + - failed + - total title: BatchRequestCounts usage: type: object @@ -3879,7 +3518,7 @@ components: type: integer additionalProperties: false required: - - cached_tokens + - cached_tokens title: InputTokensDetails output_tokens: type: integer @@ -3890,27 +3529,27 @@ components: type: integer additionalProperties: false required: - - reasoning_tokens + - reasoning_tokens title: OutputTokensDetails total_tokens: type: integer additionalProperties: false required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens title: BatchUsage additionalProperties: false required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status title: Batch first_id: type: string @@ -3921,28 +3560,24 @@ components: default: false additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: ListBatchesResponse - description: >- - Response containing a list of batch objects. + description: Response containing a list of batch objects. CreateBatchRequest: type: object properties: input_file_id: type: string - description: >- - The ID of an uploaded file containing requests for the batch. + description: The ID of an uploaded file containing requests for the batch. endpoint: type: string - description: >- - The endpoint to be used for all requests in the batch. + description: The endpoint to be used for all requests in the batch. completion_window: type: string const: 24h - description: >- - The time window within which the batch should be processed. + description: The time window within which the batch should be processed. metadata: type: object additionalProperties: @@ -3950,13 +3585,13 @@ components: description: Optional metadata for the batch. idempotency_key: type: string - description: >- - Optional idempotency key. When provided, enables idempotent behavior. + description: Optional idempotency key. When provided, enables idempotent + behavior. additionalProperties: false required: - - input_file_id - - endpoint - - completion_window + - input_file_id + - endpoint + - completion_window title: CreateBatchRequest Batch: type: object @@ -3977,14 +3612,14 @@ components: status: type: string enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled cancelled_at: type: integer cancelling_at: @@ -4044,9 +3679,9 @@ components: type: integer additionalProperties: false required: - - completed - - failed - - total + - completed + - failed + - total title: BatchRequestCounts usage: type: object @@ -4060,7 +3695,7 @@ components: type: integer additionalProperties: false required: - - cached_tokens + - cached_tokens title: InputTokensDetails output_tokens: type: integer @@ -4071,33 +3706,33 @@ components: type: integer additionalProperties: false required: - - reasoning_tokens + - reasoning_tokens title: OutputTokensDetails total_tokens: type: integer additionalProperties: false required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens title: BatchUsage additionalProperties: false required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status title: Batch Order: type: string enum: - - asc - - desc + - asc + - desc title: Order description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: @@ -4120,39 +3755,34 @@ components: type: string const: chat.completion default: chat.completion - description: >- - The object type, which will be "chat.completion" + description: The object type, which will be "chat.completion" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion + was created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information for the completion + description: Token usage information for the completion input_messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' additionalProperties: false required: - - id - - choices - - object - - created - - model - - input_messages + - id + - choices + - object + - created + - model + - input_messages title: OpenAICompletionWithInputMessages - description: >- - List of chat completion objects with their input messages + description: List of chat completion objects with their input messages has_more: type: boolean - description: >- - Whether there are more completions available beyond this list + description: Whether there are more completions available beyond this list first_id: type: string description: ID of the first completion in this list @@ -4163,18 +3793,16 @@ components: type: string const: list default: list - description: >- - Must be "list" to identify this as a list response + description: Must be "list" to identify this as a list response additionalProperties: false required: - - data - - has_more - - first_id - - last_id - - object + - data + - has_more + - first_id + - last_id + - object title: ListOpenAIChatCompletionResponse - description: >- - Response from listing OpenAI-compatible chat completions. + description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: type: object properties: @@ -4182,59 +3810,51 @@ components: type: string const: assistant default: assistant - description: >- - Must be "assistant" to identify this as the model's response + description: Must be "assistant" to identify this as the model's response content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The content of the model's response name: type: string - description: >- - (Optional) The name of the assistant message participant. + description: (Optional) The name of the assistant message participant. tool_calls: type: array items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - description: >- - List of tool calls. Each tool call is an OpenAIChatCompletionToolCall + description: List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. additionalProperties: false required: - - role + - role title: OpenAIAssistantMessageParam - description: >- - A message containing the model's (assistant) response in an OpenAI-compatible + description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - "OpenAIChatCompletionContentPartImageParam": + OpenAIChatCompletionContentPartImageParam: type: object properties: type: type: string const: image_url default: image_url - description: >- - Must be "image_url" to identify this as image content + description: Must be "image_url" to identify this as image content image_url: $ref: '#/components/schemas/OpenAIImageURL' - description: >- - Image URL specification and processing details + description: Image URL specification and processing details additionalProperties: false required: - - type - - image_url - title: >- - OpenAIChatCompletionContentPartImageParam - description: >- - Image content part for OpenAI-compatible chat completion messages. + - type + - image_url + title: OpenAIChatCompletionContentPartImageParam + description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - - $ref: '#/components/schemas/OpenAIFile' + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + - $ref: '#/components/schemas/OpenAIFile' discriminator: propertyName: type mapping: @@ -4248,44 +3868,38 @@ components: type: string const: text default: text - description: >- - Must be "text" to identify this as text content + description: Must be "text" to identify this as text content text: type: string description: The text content of the message additionalProperties: false required: - - type - - text + - type + - text title: OpenAIChatCompletionContentPartTextParam - description: >- - Text content part for OpenAI-compatible chat completion messages. + description: Text content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionToolCall: type: object properties: index: type: integer - description: >- - (Optional) Index of the tool call in the list + description: (Optional) Index of the tool call in the list id: type: string - description: >- - (Optional) Unique identifier for the tool call + description: (Optional) Unique identifier for the tool call type: type: string const: function default: function - description: >- - Must be "function" to identify this as a function call + description: Must be "function" to identify this as a function call function: $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' description: (Optional) Function call details additionalProperties: false required: - - type + - type title: OpenAIChatCompletionToolCall - description: >- - Tool call specification for OpenAI-compatible chat completion responses. + description: Tool call specification for OpenAI-compatible chat completion responses. OpenAIChatCompletionToolCallFunction: type: object properties: @@ -4294,12 +3908,10 @@ components: description: (Optional) Name of the function to call arguments: type: string - description: >- - (Optional) Arguments to pass to the function as a JSON string + description: (Optional) Arguments to pass to the function as a JSON string additionalProperties: false title: OpenAIChatCompletionToolCallFunction - description: >- - Function call details for OpenAI-compatible tool calls. + description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: type: object properties: @@ -4319,40 +3931,34 @@ components: type: integer description: Number of tokens retrieved from cache additionalProperties: false - title: >- - OpenAIChatCompletionUsagePromptTokensDetails - description: >- - Token details for prompt tokens in OpenAI chat completion usage. + title: OpenAIChatCompletionUsagePromptTokensDetails + description: Token details for prompt tokens in OpenAI chat completion usage. completion_tokens_details: type: object properties: reasoning_tokens: type: integer - description: >- - Number of tokens used for reasoning (o1/o3 models) + description: Number of tokens used for reasoning (o1/o3 models) additionalProperties: false - title: >- - OpenAIChatCompletionUsageCompletionTokensDetails - description: >- - Token details for output tokens in OpenAI chat completion usage. + title: OpenAIChatCompletionUsageCompletionTokensDetails + description: Token details for output tokens in OpenAI chat completion usage. additionalProperties: false required: - - prompt_tokens - - completion_tokens - - total_tokens + - prompt_tokens + - completion_tokens + - total_tokens title: OpenAIChatCompletionUsage - description: >- - Usage information for OpenAI chat completion. + description: Usage information for OpenAI chat completion. OpenAIChoice: type: object properties: message: oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - - $ref: '#/components/schemas/OpenAISystemMessageParam' - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - - $ref: '#/components/schemas/OpenAIToolMessageParam' - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + - $ref: '#/components/schemas/OpenAIUserMessageParam' + - $ref: '#/components/schemas/OpenAISystemMessageParam' + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + - $ref: '#/components/schemas/OpenAIToolMessageParam' + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' discriminator: propertyName: role mapping: @@ -4370,16 +3976,14 @@ components: description: The index of the choice logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message additionalProperties: false required: - - message - - finish_reason - - index + - message + - finish_reason + - index title: OpenAIChoice - description: >- - A choice from an OpenAI-compatible chat completion response. + description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: type: object properties: @@ -4387,18 +3991,15 @@ components: type: array items: $ref: '#/components/schemas/OpenAITokenLogProb' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message refusal: type: array items: $ref: '#/components/schemas/OpenAITokenLogProb' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message additionalProperties: false title: OpenAIChoiceLogprobs - description: >- - The log probabilities for the tokens in the message from an OpenAI-compatible + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: type: object @@ -4407,26 +4008,24 @@ components: type: string const: developer default: developer - description: >- - Must be "developer" to identify this as a developer message + description: Must be "developer" to identify this as a developer message content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The content of the developer message name: type: string - description: >- - (Optional) The name of the developer message participant. + description: (Optional) The name of the developer message participant. additionalProperties: false required: - - role - - content + - role + - content title: OpenAIDeveloperMessageParam - description: >- - A message from the developer in an OpenAI-compatible chat completion request. + description: A message from the developer in an OpenAI-compatible chat completion + request. OpenAIFile: type: object properties: @@ -4438,8 +4037,8 @@ components: $ref: '#/components/schemas/OpenAIFileFile' additionalProperties: false required: - - type - - file + - type + - file title: OpenAIFile OpenAIFileFile: type: object @@ -4457,26 +4056,23 @@ components: properties: url: type: string - description: >- - URL of the image to include in the message + description: URL of the image to include in the message detail: type: string - description: >- - (Optional) Level of detail for image processing. Can be "low", "high", - or "auto" + description: (Optional) Level of detail for image processing. Can be "low", + "high", or "auto" additionalProperties: false required: - - url + - url title: OpenAIImageURL - description: >- - Image URL specification for OpenAI-compatible chat completion messages. + description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - - $ref: '#/components/schemas/OpenAISystemMessageParam' - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - - $ref: '#/components/schemas/OpenAIToolMessageParam' - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + - $ref: '#/components/schemas/OpenAIUserMessageParam' + - $ref: '#/components/schemas/OpenAISystemMessageParam' + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + - $ref: '#/components/schemas/OpenAIToolMessageParam' + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' discriminator: propertyName: role mapping: @@ -4492,29 +4088,25 @@ components: type: string const: system default: system - description: >- - Must be "system" to identify this as a system message + description: Must be "system" to identify this as a system message content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - description: >- - The content of the "system prompt". If multiple system messages are provided, - they are concatenated. The underlying Llama Stack code may also add other - system messages (for example, for formatting tool definitions). + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + description: The content of the "system prompt". If multiple system messages + are provided, they are concatenated. The underlying Llama Stack code may + also add other system messages (for example, for formatting tool definitions). name: type: string - description: >- - (Optional) The name of the system message participant. + description: (Optional) The name of the system message participant. additionalProperties: false required: - - role - - content + - role + - content title: OpenAISystemMessageParam - description: >- - A system message providing instructions or context to the model. + description: A system message providing instructions or context to the model. OpenAITokenLogProb: type: object properties: @@ -4532,13 +4124,12 @@ components: $ref: '#/components/schemas/OpenAITopLogProb' additionalProperties: false required: - - token - - logprob - - top_logprobs + - token + - logprob + - top_logprobs title: OpenAITokenLogProb - description: >- - The log probability for a token from an OpenAI-compatible chat completion - response. + description: The log probability for a token from an OpenAI-compatible chat + completion response. OpenAIToolMessageParam: type: object properties: @@ -4546,27 +4137,24 @@ components: type: string const: tool default: tool - description: >- - Must be "tool" to identify this as a tool response + description: Must be "tool" to identify this as a tool response tool_call_id: type: string - description: >- - Unique identifier for the tool call this response is for + description: Unique identifier for the tool call this response is for content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The response content from the tool additionalProperties: false required: - - role - - tool_call_id - - content + - role + - tool_call_id + - content title: OpenAIToolMessageParam - description: >- - A message representing the result of a tool invocation in an OpenAI-compatible + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. OpenAITopLogProb: type: object @@ -4581,12 +4169,11 @@ components: type: number additionalProperties: false required: - - token - - logprob + - token + - logprob title: OpenAITopLogProb - description: >- - The top log probability for a token from an OpenAI-compatible chat completion - response. + description: The top log probability for a token from an OpenAI-compatible chat + completion response. OpenAIUserMessageParam: type: object properties: @@ -4594,27 +4181,25 @@ components: type: string const: user default: user - description: >- - Must be "user" to identify this as a user message + description: Must be "user" to identify this as a user message content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartParam' - description: >- - The content of the message, which can include text and other media + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartParam' + description: The content of the message, which can include text and other + media name: type: string - description: >- - (Optional) The name of the user message participant. + description: (Optional) The name of the user message participant. additionalProperties: false required: - - role - - content + - role + - content title: OpenAIUserMessageParam - description: >- - A message from the user in an OpenAI-compatible chat completion request. + description: A message from the user in an OpenAI-compatible chat completion + request. OpenAIJSONSchema: type: object properties: @@ -4626,25 +4211,24 @@ components: description: (Optional) Description of the schema strict: type: boolean - description: >- - (Optional) Whether to enforce strict adherence to the schema + description: (Optional) Whether to enforce strict adherence to the schema schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The JSON schema definition additionalProperties: false required: - - name + - name title: OpenAIJSONSchema - description: >- - JSON schema specification for OpenAI-compatible structured response format. + description: JSON schema specification for OpenAI-compatible structured response + format. OpenAIResponseFormatJSONObject: type: object properties: @@ -4652,14 +4236,14 @@ components: type: string const: json_object default: json_object - description: >- - Must be "json_object" to indicate generic JSON object response format + description: Must be "json_object" to indicate generic JSON object response + format additionalProperties: false required: - - type + - type title: OpenAIResponseFormatJSONObject - description: >- - JSON object response format for OpenAI-compatible chat completion requests. + description: JSON object response format for OpenAI-compatible chat completion + requests. OpenAIResponseFormatJSONSchema: type: object properties: @@ -4667,24 +4251,23 @@ components: type: string const: json_schema default: json_schema - description: >- - Must be "json_schema" to indicate structured JSON response format + description: Must be "json_schema" to indicate structured JSON response + format json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' - description: >- - The JSON schema specification for the response + description: The JSON schema specification for the response additionalProperties: false required: - - type - - json_schema + - type + - json_schema title: OpenAIResponseFormatJSONSchema - description: >- - JSON schema response format for OpenAI-compatible chat completion requests. + description: JSON schema response format for OpenAI-compatible chat completion + requests. OpenAIResponseFormatParam: oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + - $ref: '#/components/schemas/OpenAIResponseFormatText' + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' discriminator: propertyName: type mapping: @@ -4698,22 +4281,19 @@ components: type: string const: text default: text - description: >- - Must be "text" to indicate plain text response format + description: Must be "text" to indicate plain text response format additionalProperties: false required: - - type + - type title: OpenAIResponseFormatText - description: >- - Text response format for OpenAI-compatible chat completion requests. + description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: type: object properties: model: type: string - description: >- - The identifier of the model to use. The model must be registered with - Llama Stack and available via the /models endpoint. + description: The identifier of the model to use. The model must be registered + with Llama Stack and available via the /models endpoint. messages: type: array items: @@ -4721,20 +4301,19 @@ components: description: List of messages in the conversation. frequency_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. function_call: oneOf: - - type: string - - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: string + - type: object + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The function call to use. functions: type: array @@ -4742,12 +4321,12 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) List of functions to use. logit_bias: type: object @@ -4759,24 +4338,19 @@ components: description: (Optional) The log probabilities to use. max_completion_tokens: type: integer - description: >- - (Optional) The maximum number of tokens to generate. + description: (Optional) The maximum number of tokens to generate. max_tokens: type: integer - description: >- - (Optional) The maximum number of tokens to generate. + description: (Optional) The maximum number of tokens to generate. n: type: integer - description: >- - (Optional) The number of completions to generate. + description: (Optional) The number of completions to generate. parallel_tool_calls: type: boolean - description: >- - (Optional) Whether to parallelize tool calls. + description: (Optional) Whether to parallelize tool calls. presence_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. response_format: $ref: '#/components/schemas/OpenAIResponseFormatParam' description: (Optional) The response format to use. @@ -4785,41 +4359,40 @@ components: description: (Optional) The seed to use. stop: oneOf: - - type: string - - type: array - items: - type: string + - type: string + - type: array + items: + type: string description: (Optional) The stop tokens to use. stream: type: boolean - description: >- - (Optional) Whether to stream the response. + description: (Optional) Whether to stream the response. stream_options: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The stream options to use. temperature: type: number description: (Optional) The temperature to use. tool_choice: oneOf: - - type: string - - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: string + - type: object + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The tool choice to use. tools: type: array @@ -4827,17 +4400,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The tools to use. top_logprobs: type: integer - description: >- - (Optional) The top log probabilities to use. + description: (Optional) The top log probabilities to use. top_p: type: number description: (Optional) The top p to use. @@ -4846,11 +4418,10 @@ components: description: (Optional) The user to use. additionalProperties: false required: - - model - - messages + - model + - messages title: OpenAIChatCompletionRequestWithExtraBody - description: >- - Request parameters for OpenAI-compatible chat completion endpoint. + description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: type: object properties: @@ -4866,30 +4437,26 @@ components: type: string const: chat.completion default: chat.completion - description: >- - The object type, which will be "chat.completion" + description: The object type, which will be "chat.completion" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion was + created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information for the completion + description: Token usage information for the completion additionalProperties: false required: - - id - - choices - - object - - created - - model + - id + - choices + - object + - created + - model title: OpenAIChatCompletion - description: >- - Response from an OpenAI-compatible chat completion request. + description: Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: type: object properties: @@ -4905,30 +4472,28 @@ components: type: string const: chat.completion.chunk default: chat.completion.chunk - description: >- - The object type, which will be "chat.completion.chunk" + description: The object type, which will be "chat.completion.chunk" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion was + created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information (typically included in final chunk with stream_options) + description: Token usage information (typically included in final chunk + with stream_options) additionalProperties: false required: - - id - - choices - - object - - created - - model + - id + - choices + - object + - created + - model title: OpenAIChatCompletionChunk - description: >- - Chunk from a streaming response to an OpenAI-compatible chat completion request. + description: Chunk from a streaming response to an OpenAI-compatible chat completion + request. OpenAIChoiceDelta: type: object properties: @@ -4948,13 +4513,11 @@ components: description: (Optional) The tool calls of the delta reasoning_content: type: string - description: >- - (Optional) The reasoning content from the model (non-standard, for o1/o3 - models) + description: (Optional) The reasoning content from the model (non-standard, + for o1/o3 models) additionalProperties: false title: OpenAIChoiceDelta - description: >- - A delta from an OpenAI-compatible chat completion streaming response. + description: A delta from an OpenAI-compatible chat completion streaming response. OpenAIChunkChoice: type: object properties: @@ -4969,16 +4532,15 @@ components: description: The index of the choice logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' - description: >- - (Optional) The log probabilities for the tokens in the message + description: (Optional) The log probabilities for the tokens in the message additionalProperties: false required: - - delta - - finish_reason - - index + - delta + - finish_reason + - index title: OpenAIChunkChoice - description: >- - A chunk choice from an OpenAI-compatible chat completion streaming response. + description: A chunk choice from an OpenAI-compatible chat completion streaming + response. OpenAICompletionWithInputMessages: type: object properties: @@ -4994,67 +4556,61 @@ components: type: string const: chat.completion default: chat.completion - description: >- - The object type, which will be "chat.completion" + description: The object type, which will be "chat.completion" created: type: integer - description: >- - The Unix timestamp in seconds when the chat completion was created + description: The Unix timestamp in seconds when the chat completion was + created model: type: string - description: >- - The model that was used to generate the chat completion + description: The model that was used to generate the chat completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' - description: >- - Token usage information for the completion + description: Token usage information for the completion input_messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' additionalProperties: false required: - - id - - choices - - object - - created - - model - - input_messages + - id + - choices + - object + - created + - model + - input_messages title: OpenAICompletionWithInputMessages OpenAICompletionRequestWithExtraBody: type: object properties: model: type: string - description: >- - The identifier of the model to use. The model must be registered with - Llama Stack and available via the /models endpoint. + description: The identifier of the model to use. The model must be registered + with Llama Stack and available via the /models endpoint. prompt: oneOf: - - type: string - - type: array - items: - type: string - - type: array + - type: string + - type: array + items: + type: string + - type: array + items: + type: integer + - type: array + items: + type: array items: type: integer - - type: array - items: - type: array - items: - type: integer description: The prompt to generate a completion for. best_of: type: integer - description: >- - (Optional) The number of completions to generate. + description: (Optional) The number of completions to generate. echo: type: boolean description: (Optional) Whether to echo the prompt. frequency_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. logit_bias: type: object additionalProperties: @@ -5065,40 +4621,36 @@ components: description: (Optional) The log probabilities to use. max_tokens: type: integer - description: >- - (Optional) The maximum number of tokens to generate. + description: (Optional) The maximum number of tokens to generate. n: type: integer - description: >- - (Optional) The number of completions to generate. + description: (Optional) The number of completions to generate. presence_penalty: type: number - description: >- - (Optional) The penalty for repeated tokens. + description: (Optional) The penalty for repeated tokens. seed: type: integer description: (Optional) The seed to use. stop: oneOf: - - type: string - - type: array - items: - type: string + - type: string + - type: array + items: + type: string description: (Optional) The stop tokens to use. stream: type: boolean - description: >- - (Optional) Whether to stream the response. + description: (Optional) Whether to stream the response. stream_options: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) The stream options to use. temperature: type: number @@ -5111,15 +4663,13 @@ components: description: (Optional) The user to use. suffix: type: string - description: >- - (Optional) The suffix that should be appended to the completion. + description: (Optional) The suffix that should be appended to the completion. additionalProperties: false required: - - model - - prompt + - model + - prompt title: OpenAICompletionRequestWithExtraBody - description: >- - Request parameters for OpenAI-compatible completion endpoint. + description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: type: object properties: @@ -5139,14 +4689,13 @@ components: default: text_completion additionalProperties: false required: - - id - - choices - - created - - model - - object + - id + - choices + - created + - model + - object title: OpenAICompletion - description: >- - Response from an OpenAI-compatible completion request. + description: Response from an OpenAI-compatible completion request. OpenAICompletionChoice: type: object properties: @@ -5160,23 +4709,22 @@ components: $ref: '#/components/schemas/OpenAIChoiceLogprobs' additionalProperties: false required: - - finish_reason - - text - - index + - finish_reason + - text + - index title: OpenAICompletionChoice - description: >- - A choice from an OpenAI-compatible completion response. + description: A choice from an OpenAI-compatible completion response. ConversationItem: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' discriminator: propertyName: type mapping: @@ -5196,16 +4744,13 @@ components: type: string const: url_citation default: url_citation - description: >- - Annotation type identifier, always "url_citation" + description: Annotation type identifier, always "url_citation" end_index: type: integer - description: >- - End position of the citation span in the content + description: End position of the citation span in the content start_index: type: integer - description: >- - Start position of the citation span in the content + description: Start position of the citation span in the content title: type: string description: Title of the referenced web resource @@ -5214,15 +4759,14 @@ components: description: URL of the referenced web resource additionalProperties: false required: - - type - - end_index - - start_index - - title - - url + - type + - end_index + - start_index + - title + - url title: OpenAIResponseAnnotationCitation - description: >- - URL citation annotation for referencing external web resources. - "OpenAIResponseAnnotationContainerFileCitation": + description: URL citation annotation for referencing external web resources. + OpenAIResponseAnnotationContainerFileCitation: type: object properties: type: @@ -5241,14 +4785,13 @@ components: type: integer additionalProperties: false required: - - type - - container_id - - end_index - - file_id - - filename - - start_index - title: >- - OpenAIResponseAnnotationContainerFileCitation + - type + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation OpenAIResponseAnnotationFileCitation: type: object properties: @@ -5256,8 +4799,7 @@ components: type: string const: file_citation default: file_citation - description: >- - Annotation type identifier, always "file_citation" + description: Annotation type identifier, always "file_citation" file_id: type: string description: Unique identifier of the referenced file @@ -5266,17 +4808,16 @@ components: description: Name of the referenced file index: type: integer - description: >- - Position index of the citation within the content + description: Position index of the citation within the content additionalProperties: false required: - - type - - file_id - - filename - - index + - type + - file_id + - filename + - index title: OpenAIResponseAnnotationFileCitation - description: >- - File citation annotation for referencing specific files in response content. + description: File citation annotation for referencing specific files in response + content. OpenAIResponseAnnotationFilePath: type: object properties: @@ -5290,16 +4831,16 @@ components: type: integer additionalProperties: false required: - - type - - file_id - - index + - type + - file_id + - index title: OpenAIResponseAnnotationFilePath OpenAIResponseAnnotations: oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' discriminator: propertyName: type mapping: @@ -5314,19 +4855,17 @@ components: type: string const: refusal default: refusal - description: >- - Content part type identifier, always "refusal" + description: Content part type identifier, always "refusal" refusal: type: string description: Refusal text supplied by the model additionalProperties: false required: - - type - - refusal + - type + - refusal title: OpenAIResponseContentPartRefusal - description: >- - Refusal content within a streamed response part. - "OpenAIResponseInputFunctionToolCallOutput": + description: Refusal content within a streamed response part. + OpenAIResponseInputFunctionToolCallOutput: type: object properties: call_id: @@ -5343,19 +4882,17 @@ components: type: string additionalProperties: false required: - - call_id - - output - - type - title: >- - OpenAIResponseInputFunctionToolCallOutput - description: >- - This represents the output of a function call that gets passed back to the - model. + - call_id + - output + - type + title: OpenAIResponseInputFunctionToolCallOutput + description: This represents the output of a function call that gets passed + back to the model. OpenAIResponseInputMessageContent: oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' discriminator: propertyName: type mapping: @@ -5369,64 +4906,55 @@ components: type: string const: input_file default: input_file - description: >- - The type of the input item. Always `input_file`. + description: The type of the input item. Always `input_file`. file_data: type: string - description: >- - The data of the file to be sent to the model. + description: The data of the file to be sent to the model. file_id: type: string - description: >- - (Optional) The ID of the file to be sent to the model. + description: (Optional) The ID of the file to be sent to the model. file_url: type: string - description: >- - The URL of the file to be sent to the model. + description: The URL of the file to be sent to the model. filename: type: string - description: >- - The name of the file to be sent to the model. + description: The name of the file to be sent to the model. additionalProperties: false required: - - type + - type title: OpenAIResponseInputMessageContentFile - description: >- - File content for input messages in OpenAI response format. + description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: type: object properties: detail: oneOf: - - type: string - const: low - - type: string - const: high - - type: string - const: auto + - type: string + const: low + - type: string + const: high + - type: string + const: auto default: auto - description: >- - Level of detail for image processing, can be "low", "high", or "auto" + description: Level of detail for image processing, can be "low", "high", + or "auto" type: type: string const: input_image default: input_image - description: >- - Content type identifier, always "input_image" + description: Content type identifier, always "input_image" file_id: type: string - description: >- - (Optional) The ID of the file to be sent to the model. + description: (Optional) The ID of the file to be sent to the model. image_url: type: string description: (Optional) URL of the image content additionalProperties: false required: - - detail - - type + - detail + - type title: OpenAIResponseInputMessageContentImage - description: >- - Image content for input messages in OpenAI response format. + description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: type: object properties: @@ -5437,15 +4965,13 @@ components: type: string const: input_text default: input_text - description: >- - Content type identifier, always "input_text" + description: Content type identifier, always "input_text" additionalProperties: false required: - - text - - type + - text + - type title: OpenAIResponseInputMessageContentText - description: >- - Text content for input messages in OpenAI response format. + description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: type: object properties: @@ -5463,14 +4989,13 @@ components: default: mcp_approval_request additionalProperties: false required: - - arguments - - id - - name - - server_label - - type + - arguments + - id + - name + - server_label + - type title: OpenAIResponseMCPApprovalRequest - description: >- - A request for human approval of a tool invocation. + description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: type: object properties: @@ -5488,9 +5013,9 @@ components: type: string additionalProperties: false required: - - approval_request_id - - approve - - type + - approval_request_id + - approve + - type title: OpenAIResponseMCPApprovalResponse description: A response to an MCP approval request. OpenAIResponseMessage: @@ -5498,23 +5023,23 @@ components: properties: content: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIResponseInputMessageContent' - - type: array - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContent' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIResponseInputMessageContent' + - type: array + items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageContent' role: oneOf: - - type: string - const: system - - type: string - const: developer - - type: string - const: user - - type: string - const: assistant + - type: string + const: system + - type: string + const: developer + - type: string + const: user + - type: string + const: assistant type: type: string const: message @@ -5525,24 +5050,23 @@ components: type: string additionalProperties: false required: - - content - - role - - type + - content + - role + - type 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. + 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. OpenAIResponseOutputMessageContent: oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - "OpenAIResponseOutputMessageContentOutputText": + OpenAIResponseOutputMessageContentOutputText: type: object properties: text: @@ -5557,12 +5081,11 @@ components: $ref: '#/components/schemas/OpenAIResponseAnnotations' additionalProperties: false required: - - text - - type - - annotations - title: >- - OpenAIResponseOutputMessageContentOutputText - "OpenAIResponseOutputMessageFileSearchToolCall": + - text + - type + - annotations + title: OpenAIResponseOutputMessageContentOutputText + OpenAIResponseOutputMessageFileSearchToolCall: type: object properties: id: @@ -5575,14 +5098,12 @@ components: description: List of search queries executed status: type: string - description: >- - Current status of the file search operation + description: Current status of the file search operation type: type: string const: file_search_call default: file_search_call - description: >- - Tool call type identifier, always "file_search_call" + description: Tool call type identifier, always "file_search_call" results: type: array items: @@ -5592,52 +5113,45 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Key-value attributes associated with the file + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Key-value attributes associated with the file file_id: type: string - description: >- - Unique identifier of the file containing the result + description: Unique identifier of the file containing the result filename: type: string description: Name of the file containing the result score: type: number - description: >- - Relevance score for this search result (between 0 and 1) + description: Relevance score for this search result (between 0 and + 1) text: type: string description: Text content of the search result additionalProperties: false required: - - attributes - - file_id - - filename - - score - - text - title: >- - OpenAIResponseOutputMessageFileSearchToolCallResults - description: >- - Search results returned by the file search operation. - description: >- - (Optional) Search results returned by the file search operation + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + description: Search results returned by the file search operation. + description: (Optional) Search results returned by the file search operation additionalProperties: false required: - - id - - queries - - status - - type - title: >- - OpenAIResponseOutputMessageFileSearchToolCall - description: >- - File search tool call output message for OpenAI responses. - "OpenAIResponseOutputMessageFunctionToolCall": + - id + - queries + - status + - type + title: OpenAIResponseOutputMessageFileSearchToolCall + description: File search tool call output message for OpenAI responses. + OpenAIResponseOutputMessageFunctionToolCall: type: object properties: call_id: @@ -5648,32 +5162,26 @@ components: description: Name of the function being called arguments: type: string - description: >- - JSON string containing the function arguments + description: JSON string containing the function arguments type: type: string const: function_call default: function_call - description: >- - Tool call type identifier, always "function_call" + description: Tool call type identifier, always "function_call" id: type: string - description: >- - (Optional) Additional identifier for the tool call + description: (Optional) Additional identifier for the tool call status: type: string - description: >- - (Optional) Current status of the function call execution + description: (Optional) Current status of the function call execution additionalProperties: false required: - - call_id - - name - - arguments - - type - title: >- - OpenAIResponseOutputMessageFunctionToolCall - description: >- - Function tool call output message for OpenAI responses. + - call_id + - name + - arguments + - type + title: OpenAIResponseOutputMessageFunctionToolCall + description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: type: object properties: @@ -5684,54 +5192,45 @@ components: type: string const: mcp_call default: mcp_call - description: >- - Tool call type identifier, always "mcp_call" + description: Tool call type identifier, always "mcp_call" arguments: type: string - description: >- - JSON string containing the MCP call arguments + description: JSON string containing the MCP call arguments name: type: string description: Name of the MCP method being called server_label: type: string - description: >- - Label identifying the MCP server handling the call + description: Label identifying the MCP server handling the call error: type: string - description: >- - (Optional) Error message if the MCP call failed + description: (Optional) Error message if the MCP call failed output: type: string - description: >- - (Optional) Output result from the successful MCP call + description: (Optional) Output result from the successful MCP call additionalProperties: false required: - - id - - type - - arguments - - name - - server_label + - id + - type + - arguments + - name + - server_label title: OpenAIResponseOutputMessageMCPCall - description: >- - Model Context Protocol (MCP) call output message for OpenAI responses. + description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: type: object properties: id: type: string - description: >- - Unique identifier for this MCP list tools operation + description: Unique identifier for this MCP list tools operation type: type: string const: mcp_list_tools default: mcp_list_tools - description: >- - Tool call type identifier, always "mcp_list_tools" + description: Tool call type identifier, always "mcp_list_tools" server_label: type: string - description: >- - Label identifying the MCP server providing the tools + description: Label identifying the MCP server providing the tools tools: type: array items: @@ -5741,40 +5240,36 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - JSON schema defining the tool's input parameters + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: JSON schema defining the tool's input parameters name: type: string description: Name of the tool description: type: string - description: >- - (Optional) Description of what the tool does + description: (Optional) Description of what the tool does additionalProperties: false required: - - input_schema - - name + - input_schema + - name title: MCPListToolsTool - description: >- - Tool definition returned by MCP list tools operation. - description: >- - List of available tools provided by the MCP server + description: Tool definition returned by MCP list tools operation. + description: List of available tools provided by the MCP server additionalProperties: false required: - - id - - type - - server_label - - tools + - id + - type + - server_label + - tools title: OpenAIResponseOutputMessageMCPListTools - description: >- - MCP list tools output message containing available tools from an MCP server. - "OpenAIResponseOutputMessageWebSearchToolCall": + description: MCP list tools output message containing available tools from an + MCP server. + OpenAIResponseOutputMessageWebSearchToolCall: type: object properties: id: @@ -5782,23 +5277,19 @@ components: description: Unique identifier for this tool call status: type: string - description: >- - Current status of the web search operation + description: Current status of the web search operation type: type: string const: web_search_call default: web_search_call - description: >- - Tool call type identifier, always "web_search_call" + description: Tool call type identifier, always "web_search_call" additionalProperties: false required: - - id - - status - - type - title: >- - OpenAIResponseOutputMessageWebSearchToolCall - description: >- - Web search tool call output message for OpenAI responses. + - id + - status + - type + title: OpenAIResponseOutputMessageWebSearchToolCall + description: Web search tool call output message for OpenAI responses. CreateConversationRequest: type: object properties: @@ -5806,14 +5297,12 @@ components: type: array items: $ref: '#/components/schemas/ConversationItem' - description: >- - Initial items to include in the conversation context. + description: Initial items to include in the conversation context. metadata: type: object additionalProperties: type: string - description: >- - Set of key-value pairs that can be attached to an object. + description: Set of key-value pairs that can be attached to an object. additionalProperties: false title: CreateConversationRequest Conversation: @@ -5836,17 +5325,17 @@ components: items: type: object title: dict - description: >- - dict() -> new empty dictionary dict(mapping) -> new dictionary initialized - from a mapping object's (key, value) pairs dict(iterable) -> new - dictionary initialized as if via: d = {} for k, v in iterable: d[k] - = v dict(**kwargs) -> new dictionary initialized with the name=value - pairs in the keyword argument list. For example: dict(one=1, two=2) + description: 'dict() -> new empty dictionary dict(mapping) -> new dictionary + initialized from a mapping object''s (key, value) pairs dict(iterable) + -> new dictionary initialized as if via: d = {} for k, v in + iterable: d[k] = v dict(**kwargs) -> new dictionary initialized + with the name=value pairs in the keyword argument list. For example: dict(one=1, + two=2)' additionalProperties: false required: - - id - - object - - created_at + - id + - object + - created_at title: Conversation description: OpenAI-compatible conversation object. UpdateConversationRequest: @@ -5856,11 +5345,10 @@ components: type: object additionalProperties: type: string - description: >- - Set of key-value pairs that can be attached to an object. + description: Set of key-value pairs that can be attached to an object. additionalProperties: false required: - - metadata + - metadata title: UpdateConversationRequest ConversationDeletedResource: type: object @@ -5875,9 +5363,9 @@ components: default: true additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: ConversationDeletedResource description: Response for deleted conversation. ConversationItemList: @@ -5899,12 +5387,11 @@ components: default: false additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: ConversationItemList - description: >- - List of conversation items with pagination. + description: List of conversation items with pagination. AddItemsRequest: type: object properties: @@ -5912,11 +5399,10 @@ components: type: array items: $ref: '#/components/schemas/ConversationItem' - description: >- - Items to include in the conversation context. + description: Items to include in the conversation context. additionalProperties: false required: - - items + - items title: AddItemsRequest ConversationItemDeletedResource: type: object @@ -5931,9 +5417,9 @@ components: default: true additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: ConversationItemDeletedResource description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: @@ -5941,41 +5427,35 @@ components: properties: model: type: string - description: >- - The identifier of the model to use. The model must be an embedding model - registered with Llama Stack and available via the /models endpoint. + description: The identifier of the model to use. The model must be an embedding + model registered with Llama Stack and available via the /models endpoint. input: oneOf: - - type: string - - type: array - items: - type: string - description: >- - Input text to embed, encoded as a string or array of strings. To embed - multiple inputs in a single request, pass an array of strings. + - type: string + - type: array + items: + type: string + description: Input text to embed, encoded as a string or array of strings. + To embed multiple inputs in a single request, pass an array of strings. encoding_format: type: string default: float - description: >- - (Optional) The format to return the embeddings in. Can be either "float" - or "base64". Defaults to "float". + description: (Optional) The format to return the embeddings in. Can be either + "float" or "base64". Defaults to "float". dimensions: type: integer - description: >- - (Optional) The number of dimensions the resulting output embeddings should - have. Only supported in text-embedding-3 and later models. + description: (Optional) The number of dimensions the resulting output embeddings + should have. Only supported in text-embedding-3 and later models. user: type: string - description: >- - (Optional) A unique identifier representing your end-user, which can help - OpenAI to monitor and detect abuse. + description: (Optional) A unique identifier representing your end-user, + which can help OpenAI to monitor and detect abuse. additionalProperties: false required: - - model - - input + - model + - input title: OpenAIEmbeddingsRequestWithExtraBody - description: >- - Request parameters for OpenAI-compatible embeddings endpoint. + description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: type: object properties: @@ -5983,29 +5463,26 @@ components: type: string const: embedding default: embedding - description: >- - The object type, which will be "embedding" + description: The object type, which will be "embedding" embedding: oneOf: - - type: array - items: - type: number - - type: string - description: >- - The embedding vector as a list of floats (when encoding_format="float") + - type: array + items: + type: number + - type: string + description: The embedding vector as a list of floats (when encoding_format="float") or as a base64-encoded string (when encoding_format="base64") index: type: integer - description: >- - The index of the embedding in the input list + description: The index of the embedding in the input list additionalProperties: false required: - - object - - embedding - - index + - object + - embedding + - index title: OpenAIEmbeddingData - description: >- - A single embedding data object from an OpenAI-compatible embeddings response. + description: A single embedding data object from an OpenAI-compatible embeddings + response. OpenAIEmbeddingUsage: type: object properties: @@ -6017,11 +5494,10 @@ components: description: The total number of tokens used additionalProperties: false required: - - prompt_tokens - - total_tokens + - prompt_tokens + - total_tokens title: OpenAIEmbeddingUsage - description: >- - Usage information for an OpenAI-compatible embeddings response. + description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: type: object properties: @@ -6037,28 +5513,25 @@ components: description: List of embedding data objects model: type: string - description: >- - The model that was used to generate the embeddings + description: The model that was used to generate the embeddings usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' description: Usage information additionalProperties: false required: - - object - - data - - model - - usage + - object + - data + - model + - usage title: OpenAIEmbeddingsResponse - description: >- - Response from an OpenAI-compatible embeddings request. + description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: type: string enum: - - assistants - - batch + - assistants + - batch title: OpenAIFilePurpose - description: >- - Valid purpose values for OpenAI Files API. + description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: type: object properties: @@ -6069,16 +5542,13 @@ components: description: List of file objects has_more: type: boolean - description: >- - Whether there are more files available beyond this page + description: Whether there are more files available beyond this page first_id: type: string - description: >- - ID of the first file in the list for pagination + description: ID of the first file in the list for pagination last_id: type: string - description: >- - ID of the last file in the list for pagination + description: ID of the last file in the list for pagination object: type: string const: list @@ -6086,14 +5556,13 @@ components: description: The object type, which is always "list" additionalProperties: false required: - - data - - has_more - - first_id - - last_id - - object + - data + - has_more + - first_id + - last_id + - object title: ListOpenAIFileResponse - description: >- - Response for listing files in OpenAI Files API. + description: Response for listing files in OpenAI Files API. OpenAIFileObject: type: object properties: @@ -6104,40 +5573,36 @@ components: description: The object type, which is always "file" id: type: string - description: >- - The file identifier, which can be referenced in the API endpoints + description: The file identifier, which can be referenced in the API endpoints bytes: type: integer description: The size of the file, in bytes created_at: type: integer - description: >- - The Unix timestamp (in seconds) for when the file was created + description: The Unix timestamp (in seconds) for when the file was created expires_at: type: integer - description: >- - The Unix timestamp (in seconds) for when the file expires + description: The Unix timestamp (in seconds) for when the file expires filename: type: string description: The name of the file purpose: type: string enum: - - assistants - - batch + - assistants + - batch description: The intended purpose of the file additionalProperties: false required: - - object - - id - - bytes - - created_at - - expires_at - - filename - - purpose + - object + - id + - bytes + - created_at + - expires_at + - filename + - purpose title: OpenAIFileObject - description: >- - OpenAI File object as defined in the OpenAI Files API. + description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: type: object properties: @@ -6148,15 +5613,12 @@ components: type: integer additionalProperties: false required: - - anchor - - seconds + - 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) + description: "Control expiration of uploaded files.\nParams:\n - anchor, must\ + \ be \"created_at\"\n - seconds, must be int between 3600 and 2592000 (1 hour\ + \ to 30 days)" OpenAIFileDeleteResponse: type: object properties: @@ -6170,16 +5632,14 @@ components: description: The object type, which is always "file" deleted: type: boolean - description: >- - Whether the file was successfully deleted + description: Whether the file was successfully deleted additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: OpenAIFileDeleteResponse - description: >- - Response for deleting a file in OpenAI Files API. + description: Response for deleting a file in OpenAI Files API. Response: type: object title: Response @@ -6189,16 +5649,15 @@ components: status: type: string enum: - - OK - - Error - - Not Implemented + - OK + - Error + - Not Implemented description: Current health status of the service additionalProperties: false required: - - status + - status title: HealthInfo - description: >- - Health status information for the service. + description: Health status information for the service. RouteInfo: type: object properties: @@ -6212,17 +5671,15 @@ components: type: array items: type: string - description: >- - List of provider types that implement this route + description: List of provider types that implement this route additionalProperties: false required: - - route - - method - - provider_types + - route + - method + - provider_types title: RouteInfo - description: >- - Information about an API route including its path, method, and implementing - providers. + description: Information about an API route including its path, method, and + implementing providers. ListRoutesResponse: type: object properties: @@ -6230,14 +5687,12 @@ components: type: array items: $ref: '#/components/schemas/RouteInfo' - description: >- - List of available route information objects + description: List of available route information objects additionalProperties: false required: - - data + - data title: ListRoutesResponse - description: >- - Response containing a list of all available API routes. + description: Response containing a list of all available API routes. OpenAIModel: type: object properties: @@ -6255,18 +5710,18 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object additionalProperties: false required: - - id - - object - - created - - owned_by + - id + - object + - created + - owned_by title: OpenAIModel description: A model from OpenAI. OpenAIListModelsResponse: @@ -6278,17 +5733,16 @@ components: $ref: '#/components/schemas/OpenAIModel' additionalProperties: false required: - - data + - data title: OpenAIListModelsResponse ModelType: type: string enum: - - llm - - embedding - - rerank + - llm + - embedding + - rerank title: ModelType - description: >- - Enumeration of supported model types in Llama Stack. + description: Enumeration of supported model types in Llama Stack. RegisterModelRequest: type: object properties: @@ -6297,8 +5751,7 @@ components: description: The identifier of the model to register. provider_model_id: type: string - description: >- - The identifier of the model in the provider. + description: The identifier of the model in the provider. provider_id: type: string description: The identifier of the provider. @@ -6306,108 +5759,99 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Any additional metadata for this model. model_type: $ref: '#/components/schemas/ModelType' description: The type of model to register. additionalProperties: false required: - - model_id + - model_id title: RegisterModelRequest Model: type: object properties: identifier: type: string - description: >- - Unique identifier for this resource in llama stack + description: Unique identifier for this resource in llama stack provider_resource_id: type: string - description: >- - Unique identifier for this resource in the provider + description: Unique identifier for this resource in the provider provider_id: type: string - description: >- - ID of the provider that owns this resource + description: ID of the provider that owns this resource type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: model default: model - description: >- - The resource type, always 'model' for model resources + description: The resource type, always 'model' for model resources metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm - description: >- - The type of model (LLM or embedding model) + description: The type of model (LLM or embedding model) additionalProperties: false required: - - identifier - - provider_id - - type - - metadata - - model_type + - identifier + - provider_id + - type + - metadata + - model_type title: Model - description: >- - A model resource representing an AI model registered in Llama Stack. + description: A model resource representing an AI model registered in Llama Stack. RunModerationRequest: type: object properties: input: oneOf: - - type: string - - type: array - items: - type: string - description: >- - Input (or inputs) to classify. Can be a single string, an array of strings, - or an array of multi-modal input objects similar to other models. + - type: string + - type: array + items: + type: string + description: Input (or inputs) to classify. Can be a single string, an array + of strings, or an array of multi-modal input objects similar to other + models. model: type: string - description: >- - (Optional) The content moderation model you would like to use. + description: (Optional) The content moderation model you would like to use. additionalProperties: false required: - - input + - input title: RunModerationRequest ModerationObject: type: object properties: id: type: string - description: >- - The unique identifier for the moderation request. + description: The unique identifier for the moderation request. model: type: string - description: >- - The model used to generate the moderation results. + description: The model used to generate the moderation results. results: type: array items: @@ -6415,9 +5859,9 @@ components: description: A list of moderation objects additionalProperties: false required: - - id - - model - - results + - id + - model + - results title: ModerationObject description: A moderation object. ModerationObjectResults: @@ -6425,45 +5869,42 @@ components: properties: flagged: type: boolean - description: >- - Whether any of the below categories are flagged. + description: Whether any of the below categories are flagged. categories: type: object additionalProperties: type: boolean - description: >- - A list of the categories, and whether they are flagged or not. + description: A list of the categories, and whether they are flagged or not. category_applied_input_types: type: object additionalProperties: type: array items: type: string - description: >- - A list of the categories along with the input type(s) that the score applies - to. + description: A list of the categories along with the input type(s) that + the score applies to. category_scores: type: object additionalProperties: type: number - description: >- - A list of the categories along with their scores as predicted by model. + description: A list of the categories along with their scores as predicted + by model. user_message: type: string metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object additionalProperties: false required: - - flagged - - metadata + - flagged + - metadata title: ModerationObjectResults description: A moderation object. Prompt: @@ -6471,39 +5912,34 @@ components: properties: prompt: type: string - description: >- - The system prompt text with variable placeholders. Variables are only - supported when using the Responses API. + description: The system prompt text with variable placeholders. Variables + are only supported when using the Responses API. version: type: integer - description: >- - Version (integer starting at 1, incremented on save) + description: Version (integer starting at 1, incremented on save) prompt_id: type: string - description: >- - Unique identifier formatted as 'pmpt_<48-digit-hash>' + description: Unique identifier formatted as 'pmpt_<48-digit-hash>' variables: type: array items: type: string - description: >- - List of prompt variable names that can be used in the prompt template + description: List of prompt variable names that can be used in the prompt + template is_default: type: boolean default: false - description: >- - Boolean indicating whether this version is the default version for this - prompt + description: Boolean indicating whether this version is the default version + for this prompt additionalProperties: false required: - - version - - prompt_id - - variables - - is_default + - version + - prompt_id + - variables + - is_default title: Prompt - description: >- - A prompt resource representing a stored OpenAI Compatible prompt template - in Llama Stack. + description: A prompt resource representing a stored OpenAI Compatible prompt + template in Llama Stack. ListPromptsResponse: type: object properties: @@ -6513,7 +5949,7 @@ components: $ref: '#/components/schemas/Prompt' additionalProperties: false required: - - data + - data title: ListPromptsResponse description: Response model to list prompts. CreatePromptRequest: @@ -6521,17 +5957,15 @@ components: properties: prompt: type: string - description: >- - The prompt text content with variable placeholders. + description: The prompt text content with variable placeholders. variables: type: array items: type: string - description: >- - List of variable names that can be used in the prompt template. + description: List of variable names that can be used in the prompt template. additionalProperties: false required: - - prompt + - prompt title: CreatePromptRequest UpdatePromptRequest: type: object @@ -6541,23 +5975,21 @@ components: description: The updated prompt text content. version: type: integer - description: >- - The current version of the prompt being updated. + description: The current version of the prompt being updated. variables: type: array items: type: string - description: >- - Updated list of variable names that can be used in the prompt template. + description: Updated list of variable names that can be used in the prompt + template. set_as_default: type: boolean - description: >- - Set the new version as the default (default=True). + description: Set the new version as the default (default=True). additionalProperties: false required: - - prompt - - version - - set_as_default + - prompt + - version + - set_as_default title: UpdatePromptRequest SetDefaultVersionRequest: type: object @@ -6567,7 +5999,7 @@ components: description: The version to set as default. additionalProperties: false required: - - version + - version title: SetDefaultVersionRequest ProviderInfo: type: object @@ -6585,36 +6017,34 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Configuration parameters for the provider + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Configuration parameters for the provider health: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Current health status of the provider additionalProperties: false required: - - api - - provider_id - - provider_type - - config - - health + - api + - provider_id + - provider_type + - config + - health title: ProviderInfo - description: >- - Information about a registered provider including its configuration and health - status. + description: Information about a registered provider including its configuration + and health status. ListProvidersResponse: type: object properties: @@ -6625,10 +6055,9 @@ components: description: List of provider information objects additionalProperties: false required: - - data + - data title: ListProvidersResponse - description: >- - Response containing a list of all available providers. + description: Response containing a list of all available providers. ListOpenAIResponseObject: type: object properties: @@ -6636,16 +6065,13 @@ components: type: array items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' - description: >- - List of response objects with their input context + description: List of response objects with their input context has_more: type: boolean - description: >- - Whether there are more results available beyond this page + description: Whether there are more results available beyond this page first_id: type: string - description: >- - Identifier of the first item in this page + description: Identifier of the first item in this page last_id: type: string description: Identifier of the last item in this page @@ -6656,38 +6082,34 @@ components: description: Object type identifier, always "list" additionalProperties: false required: - - data - - has_more - - first_id - - last_id - - object + - data + - has_more + - first_id + - last_id + - object title: ListOpenAIResponseObject - description: >- - Paginated list of OpenAI response objects with navigation metadata. + description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: type: object properties: code: type: string - description: >- - Error code identifying the type of failure + description: Error code identifying the type of failure message: type: string - description: >- - Human-readable error message describing the failure + description: Human-readable error message describing the failure additionalProperties: false required: - - code - - message + - code + - message title: OpenAIResponseError - description: >- - Error details for failed OpenAI response requests. + description: Error details for failed OpenAI response requests. OpenAIResponseInput: oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutput' - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutput' + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + - $ref: '#/components/schemas/OpenAIResponseMessage' OpenAIResponseInputToolFileSearch: type: object properties: @@ -6695,53 +6117,45 @@ components: type: string const: file_search default: file_search - description: >- - Tool type identifier, always "file_search" + description: Tool type identifier, always "file_search" vector_store_ids: type: array items: type: string - description: >- - List of vector store identifiers to search within + description: List of vector store identifiers to search within filters: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional filters to apply to the search + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional filters to apply to the search max_num_results: type: integer default: 10 - description: >- - (Optional) Maximum number of search results to return (1-50) + description: (Optional) Maximum number of search results to return (1-50) ranking_options: type: object properties: ranker: type: string - description: >- - (Optional) Name of the ranking algorithm to use + description: (Optional) Name of the ranking algorithm to use score_threshold: type: number default: 0.0 - description: >- - (Optional) Minimum relevance score threshold for results + description: (Optional) Minimum relevance score threshold for results additionalProperties: false - description: >- - (Optional) Options for ranking and scoring search results + description: (Optional) Options for ranking and scoring search results additionalProperties: false required: - - type - - vector_store_ids + - type + - vector_store_ids title: OpenAIResponseInputToolFileSearch - description: >- - File search tool configuration for OpenAI response inputs. + description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: type: object properties: @@ -6755,66 +6169,59 @@ components: description: Name of the function that can be called description: type: string - description: >- - (Optional) Description of what the function does + description: (Optional) Description of what the function does parameters: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) JSON schema defining the function's parameters + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) JSON schema defining the function's parameters strict: type: boolean - description: >- - (Optional) Whether to enforce strict parameter validation + description: (Optional) Whether to enforce strict parameter validation additionalProperties: false required: - - type - - name + - type + - name title: OpenAIResponseInputToolFunction - description: >- - Function tool configuration for OpenAI response inputs. + description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: type: object properties: type: oneOf: - - type: string - const: web_search - - type: string - const: web_search_preview - - type: string - const: web_search_preview_2025_03_11 + - type: string + const: web_search + - type: string + const: web_search_preview + - type: string + const: web_search_preview_2025_03_11 default: web_search description: Web search tool type variant to use search_context_size: type: string default: medium - description: >- - (Optional) Size of search context, must be "low", "medium", or "high" + description: (Optional) Size of search context, must be "low", "medium", + or "high" additionalProperties: false required: - - type + - type title: OpenAIResponseInputToolWebSearch - description: >- - Web search tool configuration for OpenAI response inputs. + description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: type: object properties: created_at: type: integer - description: >- - Unix timestamp when the response was created + description: Unix timestamp when the response was created error: $ref: '#/components/schemas/OpenAIResponseError' - description: >- - (Optional) Error details if the response generation failed + description: (Optional) Error details if the response generation failed id: type: string description: Unique identifier for this response @@ -6825,90 +6232,76 @@ components: type: string const: response default: response - description: >- - Object type identifier, always "response" + description: Object type identifier, always "response" output: type: array items: $ref: '#/components/schemas/OpenAIResponseOutput' - description: >- - List of generated output items (messages, tool calls, etc.) + description: List of generated output items (messages, tool calls, etc.) parallel_tool_calls: type: boolean default: false - description: >- - Whether tool calls can be executed in parallel + description: Whether tool calls can be executed in parallel previous_response_id: type: string - description: >- - (Optional) ID of the previous response in a conversation + description: (Optional) ID of the previous response in a conversation prompt: $ref: '#/components/schemas/OpenAIResponsePrompt' - description: >- - (Optional) Reference to a prompt template and its variables. + description: (Optional) Reference to a prompt template and its variables. status: type: string - description: >- - Current status of the response generation + description: Current status of the response generation temperature: type: number - description: >- - (Optional) Sampling temperature used for generation + description: (Optional) Sampling temperature used for generation text: $ref: '#/components/schemas/OpenAIResponseText' - description: >- - Text formatting configuration for the response + description: Text formatting configuration for the response top_p: type: number - description: >- - (Optional) Nucleus sampling parameter used for generation + description: (Optional) Nucleus sampling parameter used for generation tools: type: array items: $ref: '#/components/schemas/OpenAIResponseTool' - description: >- - (Optional) An array of tools the model may call while generating a response. + description: (Optional) An array of tools the model may call while generating + a response. truncation: type: string - description: >- - (Optional) Truncation strategy applied to the response + description: (Optional) Truncation strategy applied to the response usage: $ref: '#/components/schemas/OpenAIResponseUsage' - description: >- - (Optional) Token usage information for the response + description: (Optional) Token usage information for the response instructions: type: string - description: >- - (Optional) System message inserted into the model's context + description: (Optional) System message inserted into the model's context input: type: array items: $ref: '#/components/schemas/OpenAIResponseInput' - description: >- - List of input items that led to this response + description: List of input items that led to this response additionalProperties: false required: - - created_at - - id - - model - - object - - output - - parallel_tool_calls - - status - - text - - input + - created_at + - id + - model + - object + - output + - parallel_tool_calls + - status + - text + - input title: OpenAIResponseObjectWithInput - description: >- - OpenAI response object extended with input context information. + description: OpenAI response object extended with input context information. OpenAIResponseOutput: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: @@ -6929,20 +6322,18 @@ components: type: object additionalProperties: $ref: '#/components/schemas/OpenAIResponseInputMessageContent' - description: >- - Dictionary of variable names to OpenAIResponseInputMessageContent structure - for template substitution. The substitution values can either be strings, - or other Response input types like images or files. + description: Dictionary of variable names to OpenAIResponseInputMessageContent + structure for template substitution. The substitution values can either + be strings, or other Response input types like images or files. version: type: string - description: >- - Version number of the prompt to use (defaults to latest if not specified) + description: Version number of the prompt to use (defaults to latest if + not specified) additionalProperties: false required: - - id + - id title: OpenAIResponsePrompt - description: >- - OpenAI compatible Prompt object that is used in OpenAI responses. + description: OpenAI compatible Prompt object that is used in OpenAI responses. OpenAIResponseText: type: object properties: @@ -6951,56 +6342,52 @@ components: properties: type: oneOf: - - type: string - const: text - - type: string - const: json_schema - - type: string - const: json_object - description: >- - Must be "text", "json_schema", or "json_object" to identify the format - type + - type: string + const: text + - type: string + const: json_schema + - type: string + const: json_object + description: Must be "text", "json_schema", or "json_object" to identify + the format type name: type: string - description: >- - The name of the response format. Only used for json_schema. + description: The name of the response format. Only used for json_schema. schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The JSON schema the response should conform to. In a Python SDK, this - is often a `pydantic` model. Only used for json_schema. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The JSON schema the response should conform to. In a Python + SDK, this is often a `pydantic` model. Only used for json_schema. description: type: string - description: >- - (Optional) A description of the response format. Only used for json_schema. + description: (Optional) A description of the response format. Only used + for json_schema. strict: type: boolean - description: >- - (Optional) Whether to strictly enforce the JSON schema. If true, the - response must match the schema exactly. Only used for json_schema. + description: (Optional) Whether to strictly enforce the JSON schema. + If true, the response must match the schema exactly. Only used for + json_schema. additionalProperties: false required: - - type - description: >- - (Optional) Text format configuration specifying output format requirements + - type + description: (Optional) Text format configuration specifying output format + requirements additionalProperties: false title: OpenAIResponseText - description: >- - Text response configuration for OpenAI responses. + description: Text response configuration for OpenAI responses. OpenAIResponseTool: oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - - $ref: '#/components/schemas/OpenAIResponseToolMCP' + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + - $ref: '#/components/schemas/OpenAIResponseToolMCP' discriminator: propertyName: type mapping: @@ -7021,30 +6408,29 @@ components: description: Label to identify this MCP server allowed_tools: oneOf: - - type: array - items: - type: string - - type: object - properties: - tool_names: - type: array - items: - type: string - description: >- - (Optional) List of specific tool names that are allowed - additionalProperties: false - title: AllowedToolsFilter - description: >- - Filter configuration for restricting which MCP tools can be used. - description: >- - (Optional) Restriction on which tools can be used from this server + - type: array + items: + type: string + - type: object + properties: + tool_names: + type: array + items: + type: string + description: (Optional) List of specific tool names that are allowed + additionalProperties: false + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can + be used. + description: (Optional) Restriction on which tools can be used from this + server additionalProperties: false required: - - type - - server_label + - type + - server_label title: OpenAIResponseToolMCP - description: >- - Model Context Protocol (MCP) tool configuration for OpenAI response object. + description: Model Context Protocol (MCP) tool configuration for OpenAI response + object. OpenAIResponseUsage: type: object properties: @@ -7070,15 +6456,14 @@ components: properties: reasoning_tokens: type: integer - description: >- - Number of tokens used for reasoning (o1/o3 models) + description: Number of tokens used for reasoning (o1/o3 models) additionalProperties: false description: Detailed breakdown of output token usage additionalProperties: false required: - - input_tokens - - output_tokens - - total_tokens + - input_tokens + - output_tokens + - total_tokens title: OpenAIResponseUsage description: Usage information for OpenAI response. ResponseGuardrailSpec: @@ -7089,16 +6474,15 @@ components: description: The type/identifier of the guardrail. additionalProperties: false required: - - type + - type title: ResponseGuardrailSpec - description: >- - Specification for a guardrail to apply during response generation. + description: Specification for a guardrail to apply during response generation. OpenAIResponseInputTool: oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' discriminator: propertyName: type mapping: @@ -7124,100 +6508,92 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) HTTP headers to include when connecting to the server + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) HTTP headers to include when connecting to the server require_approval: oneOf: - - type: string - const: always - - type: string - const: never - - type: object - properties: - always: - type: array - items: - type: string - description: >- - (Optional) List of tool names that always require approval - never: - type: array - items: - type: string - description: >- - (Optional) List of tool names that never require approval - additionalProperties: false - title: ApprovalFilter - description: >- - Filter configuration for MCP tool approval requirements. + - type: string + const: always + - type: string + const: never + - type: object + properties: + always: + type: array + items: + type: string + description: (Optional) List of tool names that always require approval + never: + type: array + items: + type: string + description: (Optional) List of tool names that never require approval + additionalProperties: false + title: ApprovalFilter + description: Filter configuration for MCP tool approval requirements. default: never - description: >- - Approval requirement for tool calls ("always", "never", or filter) + description: Approval requirement for tool calls ("always", "never", or + filter) allowed_tools: oneOf: - - type: array - items: - type: string - - type: object - properties: - tool_names: - type: array - items: - type: string - description: >- - (Optional) List of specific tool names that are allowed - additionalProperties: false - title: AllowedToolsFilter - description: >- - Filter configuration for restricting which MCP tools can be used. - description: >- - (Optional) Restriction on which tools can be used from this server + - type: array + items: + type: string + - type: object + properties: + tool_names: + type: array + items: + type: string + description: (Optional) List of specific tool names that are allowed + additionalProperties: false + title: AllowedToolsFilter + description: Filter configuration for restricting which MCP tools can + be used. + description: (Optional) Restriction on which tools can be used from this + server additionalProperties: false required: - - type - - server_label - - server_url - - require_approval + - type + - server_label + - server_url + - require_approval title: OpenAIResponseInputToolMCP - description: >- - Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + description: Model Context Protocol (MCP) tool configuration for OpenAI response + inputs. CreateOpenaiResponseRequest: type: object properties: input: oneOf: - - type: string - - type: array - items: - $ref: '#/components/schemas/OpenAIResponseInput' + - type: string + - type: array + items: + $ref: '#/components/schemas/OpenAIResponseInput' description: Input message(s) to create the response. model: type: string description: The underlying LLM used for completions. prompt: $ref: '#/components/schemas/OpenAIResponsePrompt' - description: >- - (Optional) Prompt object with ID, version, and variables. + description: (Optional) Prompt object with ID, version, and variables. instructions: type: string previous_response_id: type: string - description: >- - (Optional) if specified, the new response will be a continuation of the - previous response. This can be used to easily fork-off new responses from - existing responses. + description: (Optional) if specified, the new response will be a continuation + of the previous response. This can be used to easily fork-off new responses + from existing responses. conversation: type: string - description: >- - (Optional) The ID of a conversation to add the response to. Must begin - with 'conv_'. Input and output messages will be automatically added to - the conversation. + description: (Optional) The ID of a conversation to add the response to. + Must begin with 'conv_'. Input and output messages will be automatically + added to the conversation. store: type: boolean stream: @@ -7234,26 +6610,23 @@ components: type: array items: type: string - description: >- - (Optional) Additional fields to include in the response. + description: (Optional) Additional fields to include in the response. max_infer_iters: type: integer additionalProperties: false required: - - input - - model + - input + - model title: CreateOpenaiResponseRequest OpenAIResponseObject: type: object properties: created_at: type: integer - description: >- - Unix timestamp when the response was created + description: Unix timestamp when the response was created error: $ref: '#/components/schemas/OpenAIResponseError' - description: >- - (Optional) Error details if the response generation failed + description: (Optional) Error details if the response generation failed id: type: string description: Unique identifier for this response @@ -7264,74 +6637,62 @@ components: type: string const: response default: response - description: >- - Object type identifier, always "response" + description: Object type identifier, always "response" output: type: array items: $ref: '#/components/schemas/OpenAIResponseOutput' - description: >- - List of generated output items (messages, tool calls, etc.) + description: List of generated output items (messages, tool calls, etc.) parallel_tool_calls: type: boolean default: false - description: >- - Whether tool calls can be executed in parallel + description: Whether tool calls can be executed in parallel previous_response_id: type: string - description: >- - (Optional) ID of the previous response in a conversation + description: (Optional) ID of the previous response in a conversation prompt: $ref: '#/components/schemas/OpenAIResponsePrompt' - description: >- - (Optional) Reference to a prompt template and its variables. + description: (Optional) Reference to a prompt template and its variables. status: type: string - description: >- - Current status of the response generation + description: Current status of the response generation temperature: type: number - description: >- - (Optional) Sampling temperature used for generation + description: (Optional) Sampling temperature used for generation text: $ref: '#/components/schemas/OpenAIResponseText' - description: >- - Text formatting configuration for the response + description: Text formatting configuration for the response top_p: type: number - description: >- - (Optional) Nucleus sampling parameter used for generation + description: (Optional) Nucleus sampling parameter used for generation tools: type: array items: $ref: '#/components/schemas/OpenAIResponseTool' - description: >- - (Optional) An array of tools the model may call while generating a response. + description: (Optional) An array of tools the model may call while generating + a response. truncation: type: string - description: >- - (Optional) Truncation strategy applied to the response + description: (Optional) Truncation strategy applied to the response usage: $ref: '#/components/schemas/OpenAIResponseUsage' - description: >- - (Optional) Token usage information for the response + description: (Optional) Token usage information for the response instructions: type: string - description: >- - (Optional) System message inserted into the model's context + description: (Optional) System message inserted into the model's context additionalProperties: false required: - - created_at - - id - - model - - object - - output - - parallel_tool_calls - - status - - text + - created_at + - id + - model + - object + - output + - parallel_tool_calls + - status + - text title: OpenAIResponseObject - description: >- - Complete OpenAI response object containing generation results and metadata. + description: Complete OpenAI response object containing generation results and + metadata. OpenAIResponseContentPartOutputText: type: object properties: @@ -7339,8 +6700,7 @@ components: type: string const: output_text default: output_text - description: >- - Content part type identifier, always "output_text" + description: Content part type identifier, always "output_text" text: type: string description: Text emitted for this content part @@ -7348,49 +6708,44 @@ components: type: array items: $ref: '#/components/schemas/OpenAIResponseAnnotations' - description: >- - Structured annotations associated with the text + description: Structured annotations associated with the text logprobs: type: array items: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: (Optional) Token log probability details additionalProperties: false required: - - type - - text - - annotations + - type + - text + - annotations title: OpenAIResponseContentPartOutputText - description: >- - Text content within a streamed response part. - "OpenAIResponseContentPartReasoningSummary": + description: Text content within a streamed response part. + OpenAIResponseContentPartReasoningSummary: type: object properties: type: type: string const: summary_text default: summary_text - description: >- - Content part type identifier, always "summary_text" + description: Content part type identifier, always "summary_text" text: type: string description: Summary text additionalProperties: false required: - - type - - text - title: >- - OpenAIResponseContentPartReasoningSummary - description: >- - Reasoning summary part in a streamed response. + - type + - text + title: OpenAIResponseContentPartReasoningSummary + description: Reasoning summary part in a streamed response. OpenAIResponseContentPartReasoningText: type: object properties: @@ -7398,56 +6753,54 @@ components: type: string const: reasoning_text default: reasoning_text - description: >- - Content part type identifier, always "reasoning_text" + description: Content part type identifier, always "reasoning_text" text: type: string description: Reasoning text supplied by the model additionalProperties: false required: - - type - - text + - type + - text title: OpenAIResponseContentPartReasoningText - description: >- - Reasoning text emitted as part of a streamed response. + description: Reasoning text emitted as part of a streamed response. OpenAIResponseObjectStream: oneOf: - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' - - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' + - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' discriminator: propertyName: type mapping: @@ -7487,7 +6840,7 @@ components: response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' - "OpenAIResponseObjectStreamResponseCompleted": + OpenAIResponseObjectStreamResponseCompleted: type: object properties: response: @@ -7497,40 +6850,34 @@ components: type: string const: response.completed default: response.completed - description: >- - Event type identifier, always "response.completed" + description: Event type identifier, always "response.completed" additionalProperties: false required: - - response - - type - title: >- - OpenAIResponseObjectStreamResponseCompleted - description: >- - Streaming event indicating a response has been completed. - "OpenAIResponseObjectStreamResponseContentPartAdded": + - response + - type + title: OpenAIResponseObjectStreamResponseCompleted + description: Streaming event indicating a response has been completed. + OpenAIResponseObjectStreamResponseContentPartAdded: type: object properties: content_index: type: integer - description: >- - Index position of the part within the content array + description: Index position of the part within the content array response_id: type: string - description: >- - Unique identifier of the response containing this content + description: Unique identifier of the response containing this content item_id: type: string - description: >- - Unique identifier of the output item containing this content part + description: Unique identifier of the output item containing this content + part output_index: type: integer - description: >- - Index position of the output item in the response + description: Index position of the output item in the response part: oneOf: - - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' + - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' discriminator: propertyName: type mapping: @@ -7540,51 +6887,45 @@ components: description: The content part that was added sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.content_part.added default: response.content_part.added - description: >- - Event type identifier, always "response.content_part.added" + description: Event type identifier, always "response.content_part.added" additionalProperties: false required: - - content_index - - response_id - - item_id - - output_index - - part - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseContentPartAdded - description: >- - Streaming event for when a new content part is added to a response item. - "OpenAIResponseObjectStreamResponseContentPartDone": + - content_index + - response_id + - item_id + - output_index + - part + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseContentPartAdded + description: Streaming event for when a new content part is added to a response + item. + OpenAIResponseObjectStreamResponseContentPartDone: type: object properties: content_index: type: integer - description: >- - Index position of the part within the content array + description: Index position of the part within the content array response_id: type: string - description: >- - Unique identifier of the response containing this content + description: Unique identifier of the response containing this content item_id: type: string - description: >- - Unique identifier of the output item containing this content part + description: Unique identifier of the output item containing this content + part output_index: type: integer - description: >- - Index position of the output item in the response + description: Index position of the output item in the response part: oneOf: - - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' + - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' + - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' + - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' discriminator: propertyName: type mapping: @@ -7594,28 +6935,24 @@ components: description: The completed content part sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.content_part.done default: response.content_part.done - description: >- - Event type identifier, always "response.content_part.done" + description: Event type identifier, always "response.content_part.done" additionalProperties: false required: - - content_index - - response_id - - item_id - - output_index - - part - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseContentPartDone - description: >- - Streaming event for when a content part is completed. - "OpenAIResponseObjectStreamResponseCreated": + - content_index + - response_id + - item_id + - output_index + - part + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseContentPartDone + description: Streaming event for when a content part is completed. + OpenAIResponseObjectStreamResponseCreated: type: object properties: response: @@ -7625,16 +6962,13 @@ components: type: string const: response.created default: response.created - description: >- - Event type identifier, always "response.created" + description: Event type identifier, always "response.created" additionalProperties: false required: - - response - - type - title: >- - OpenAIResponseObjectStreamResponseCreated - description: >- - Streaming event indicating a new response has been created. + - response + - type + title: OpenAIResponseObjectStreamResponseCreated + description: Streaming event indicating a new response has been created. OpenAIResponseObjectStreamResponseFailed: type: object properties: @@ -7643,188 +6977,153 @@ components: description: Response object describing the failure sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.failed default: response.failed - description: >- - Event type identifier, always "response.failed" + description: Event type identifier, always "response.failed" additionalProperties: false required: - - response - - sequence_number - - type + - response + - sequence_number + - type title: OpenAIResponseObjectStreamResponseFailed - description: >- - Streaming event emitted when a response fails. - "OpenAIResponseObjectStreamResponseFileSearchCallCompleted": + description: Streaming event emitted when a response fails. + OpenAIResponseObjectStreamResponseFileSearchCallCompleted: type: object properties: item_id: type: string - description: >- - Unique identifier of the completed file search call + description: Unique identifier of the completed file search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.file_search_call.completed default: response.file_search_call.completed - description: >- - Event type identifier, always "response.file_search_call.completed" + description: Event type identifier, always "response.file_search_call.completed" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFileSearchCallCompleted - description: >- - Streaming event for completed file search calls. - "OpenAIResponseObjectStreamResponseFileSearchCallInProgress": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted + description: Streaming event for completed file search calls. + OpenAIResponseObjectStreamResponseFileSearchCallInProgress: type: object properties: item_id: type: string - description: >- - Unique identifier of the file search call + description: Unique identifier of the file search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.file_search_call.in_progress default: response.file_search_call.in_progress - description: >- - Event type identifier, always "response.file_search_call.in_progress" + description: Event type identifier, always "response.file_search_call.in_progress" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFileSearchCallInProgress - description: >- - Streaming event for file search calls in progress. - "OpenAIResponseObjectStreamResponseFileSearchCallSearching": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress + description: Streaming event for file search calls in progress. + OpenAIResponseObjectStreamResponseFileSearchCallSearching: type: object properties: item_id: type: string - description: >- - Unique identifier of the file search call + description: Unique identifier of the file search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.file_search_call.searching default: response.file_search_call.searching - description: >- - Event type identifier, always "response.file_search_call.searching" + description: Event type identifier, always "response.file_search_call.searching" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFileSearchCallSearching - description: >- - Streaming event for file search currently searching. - "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFileSearchCallSearching + description: Streaming event for file search currently searching. + OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta: type: object properties: delta: type: string - description: >- - Incremental function call arguments being added + description: Incremental function call arguments being added item_id: type: string - description: >- - Unique identifier of the function call being updated + description: Unique identifier of the function call being updated output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.function_call_arguments.delta default: response.function_call_arguments.delta - description: >- - Event type identifier, always "response.function_call_arguments.delta" + description: Event type identifier, always "response.function_call_arguments.delta" additionalProperties: false required: - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta - description: >- - Streaming event for incremental function call argument updates. - "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone": + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta + description: Streaming event for incremental function call argument updates. + OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone: type: object properties: arguments: type: string - description: >- - Final complete arguments JSON string for the function call + description: Final complete arguments JSON string for the function call item_id: type: string - description: >- - Unique identifier of the completed function call + description: Unique identifier of the completed function call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.function_call_arguments.done default: response.function_call_arguments.done - description: >- - Event type identifier, always "response.function_call_arguments.done" + description: Event type identifier, always "response.function_call_arguments.done" additionalProperties: false required: - - arguments - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone - description: >- - Streaming event for when function call arguments are completed. - "OpenAIResponseObjectStreamResponseInProgress": + - arguments + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone + description: Streaming event for when function call arguments are completed. + OpenAIResponseObjectStreamResponseInProgress: type: object properties: response: @@ -7832,50 +7131,41 @@ components: description: Current response state while in progress sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.in_progress default: response.in_progress - description: >- - Event type identifier, always "response.in_progress" + description: Event type identifier, always "response.in_progress" additionalProperties: false required: - - response - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseInProgress - description: >- - Streaming event indicating the response remains in progress. - "OpenAIResponseObjectStreamResponseIncomplete": + - response + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseInProgress + description: Streaming event indicating the response remains in progress. + OpenAIResponseObjectStreamResponseIncomplete: type: object properties: response: $ref: '#/components/schemas/OpenAIResponseObject' - description: >- - Response object describing the incomplete state + description: Response object describing the incomplete state sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.incomplete default: response.incomplete - description: >- - Event type identifier, always "response.incomplete" + description: Event type identifier, always "response.incomplete" additionalProperties: false required: - - response - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseIncomplete - description: >- - Streaming event emitted when a response ends in an incomplete state. - "OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": + - response + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseIncomplete + description: Streaming event emitted when a response ends in an incomplete state. + OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta: type: object properties: delta: @@ -7892,14 +7182,13 @@ components: default: response.mcp_call.arguments.delta additionalProperties: false required: - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta - "OpenAIResponseObjectStreamResponseMcpCallArgumentsDone": + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta + OpenAIResponseObjectStreamResponseMcpCallArgumentsDone: type: object properties: arguments: @@ -7916,54 +7205,47 @@ components: default: response.mcp_call.arguments.done additionalProperties: false required: - - arguments - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallArgumentsDone - "OpenAIResponseObjectStreamResponseMcpCallCompleted": + - arguments + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone + OpenAIResponseObjectStreamResponseMcpCallCompleted: type: object properties: sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.mcp_call.completed default: response.mcp_call.completed - description: >- - Event type identifier, always "response.mcp_call.completed" + description: Event type identifier, always "response.mcp_call.completed" additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallCompleted + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallCompleted description: Streaming event for completed MCP calls. - "OpenAIResponseObjectStreamResponseMcpCallFailed": + OpenAIResponseObjectStreamResponseMcpCallFailed: type: object properties: sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.mcp_call.failed default: response.mcp_call.failed - description: >- - Event type identifier, always "response.mcp_call.failed" + description: Event type identifier, always "response.mcp_call.failed" additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallFailed + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallFailed description: Streaming event for failed MCP calls. - "OpenAIResponseObjectStreamResponseMcpCallInProgress": + OpenAIResponseObjectStreamResponseMcpCallInProgress: type: object properties: item_id: @@ -7971,29 +7253,24 @@ components: description: Unique identifier of the MCP call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.mcp_call.in_progress default: response.mcp_call.in_progress - description: >- - Event type identifier, always "response.mcp_call.in_progress" + description: Event type identifier, always "response.mcp_call.in_progress" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpCallInProgress - description: >- - Streaming event for MCP calls in progress. - "OpenAIResponseObjectStreamResponseMcpListToolsCompleted": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpCallInProgress + description: Streaming event for MCP calls in progress. + OpenAIResponseObjectStreamResponseMcpListToolsCompleted: type: object properties: sequence_number: @@ -8004,11 +7281,10 @@ components: default: response.mcp_list_tools.completed additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpListToolsCompleted - "OpenAIResponseObjectStreamResponseMcpListToolsFailed": + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted + OpenAIResponseObjectStreamResponseMcpListToolsFailed: type: object properties: sequence_number: @@ -8019,11 +7295,10 @@ components: default: response.mcp_list_tools.failed additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpListToolsFailed - "OpenAIResponseObjectStreamResponseMcpListToolsInProgress": + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpListToolsFailed + OpenAIResponseObjectStreamResponseMcpListToolsInProgress: type: object properties: sequence_number: @@ -8034,26 +7309,24 @@ components: default: response.mcp_list_tools.in_progress additionalProperties: false required: - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseMcpListToolsInProgress - "OpenAIResponseObjectStreamResponseOutputItemAdded": + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress + OpenAIResponseObjectStreamResponseOutputItemAdded: type: object properties: response_id: type: string - description: >- - Unique identifier of the response containing this output + description: Unique identifier of the response containing this output item: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: @@ -8064,49 +7337,42 @@ components: mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - description: >- - The output item that was added (message, tool call, etc.) + description: The output item that was added (message, tool call, etc.) output_index: type: integer - description: >- - Index position of this item in the output list + description: Index position of this item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_item.added default: response.output_item.added - description: >- - Event type identifier, always "response.output_item.added" + description: Event type identifier, always "response.output_item.added" additionalProperties: false required: - - response_id - - item - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputItemAdded - description: >- - Streaming event for when a new output item is added to the response. - "OpenAIResponseObjectStreamResponseOutputItemDone": + - response_id + - item + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputItemAdded + description: Streaming event for when a new output item is added to the response. + OpenAIResponseObjectStreamResponseOutputItemDone: type: object properties: response_id: type: string - description: >- - Unique identifier of the response containing this output + description: Unique identifier of the response containing this output item: oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + - $ref: '#/components/schemas/OpenAIResponseMessage' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: @@ -8117,58 +7383,50 @@ components: mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - description: >- - The completed output item (message, tool call, etc.) + description: The completed output item (message, tool call, etc.) output_index: type: integer - description: >- - Index position of this item in the output list + description: Index position of this item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_item.done default: response.output_item.done - description: >- - Event type identifier, always "response.output_item.done" + description: Event type identifier, always "response.output_item.done" additionalProperties: false required: - - response_id - - item - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputItemDone - description: >- - Streaming event for when an output item is completed. - "OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded": + - response_id + - item + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputItemDone + description: Streaming event for when an output item is completed. + OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded: type: object properties: item_id: type: string - description: >- - Unique identifier of the item to which the annotation is being added + description: Unique identifier of the item to which the annotation is being + added output_index: type: integer - description: >- - Index position of the output item in the response's output array + description: Index position of the output item in the response's output + array content_index: type: integer - description: >- - Index position of the content part within the output item + description: Index position of the content part within the output item annotation_index: type: integer - description: >- - Index of the annotation within the content part + description: Index of the annotation within the content part annotation: oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' discriminator: propertyName: type mapping: @@ -8179,28 +7437,24 @@ components: description: The annotation object being added sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_text.annotation.added default: response.output_text.annotation.added - description: >- - Event type identifier, always "response.output_text.annotation.added" + description: Event type identifier, always "response.output_text.annotation.added" additionalProperties: false required: - - item_id - - output_index - - content_index - - annotation_index - - annotation - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded - description: >- - Streaming event for when an annotation is added to output text. - "OpenAIResponseObjectStreamResponseOutputTextDelta": + - item_id + - output_index + - content_index + - annotation_index + - annotation + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded + description: Streaming event for when an annotation is added to output text. + OpenAIResponseObjectStreamResponseOutputTextDelta: type: object properties: content_index: @@ -8211,35 +7465,29 @@ components: description: Incremental text content being added item_id: type: string - description: >- - Unique identifier of the output item being updated + description: Unique identifier of the output item being updated output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_text.delta default: response.output_text.delta - description: >- - Event type identifier, always "response.output_text.delta" + description: Event type identifier, always "response.output_text.delta" additionalProperties: false required: - - content_index - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputTextDelta - description: >- - Streaming event for incremental text content updates. - "OpenAIResponseObjectStreamResponseOutputTextDone": + - content_index + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputTextDelta + description: Streaming event for incremental text content updates. + OpenAIResponseObjectStreamResponseOutputTextDone: type: object properties: content_index: @@ -8247,39 +7495,32 @@ components: description: Index position within the text content text: type: string - description: >- - Final complete text content of the output item + description: Final complete text content of the output item item_id: type: string - description: >- - Unique identifier of the completed output item + description: Unique identifier of the completed output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.output_text.done default: response.output_text.done - description: >- - Event type identifier, always "response.output_text.done" + description: Event type identifier, always "response.output_text.done" additionalProperties: false required: - - content_index - - text - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseOutputTextDone - description: >- - Streaming event for when text output is completed. - "OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded": + - content_index + - text + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseOutputTextDone + description: Streaming event for when text output is completed. + OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded: type: object properties: item_id: @@ -8293,31 +7534,26 @@ components: description: The summary part that was added sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_part.added default: response.reasoning_summary_part.added - description: >- - Event type identifier, always "response.reasoning_summary_part.added" + description: Event type identifier, always "response.reasoning_summary_part.added" additionalProperties: false required: - - item_id - - output_index - - part - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded - description: >- - Streaming event for when a new reasoning summary part is added. - "OpenAIResponseObjectStreamResponseReasoningSummaryPartDone": + - item_id + - output_index + - part + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded + description: Streaming event for when a new reasoning summary part is added. + OpenAIResponseObjectStreamResponseReasoningSummaryPartDone: type: object properties: item_id: @@ -8331,31 +7567,26 @@ components: description: The completed summary part sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_part.done default: response.reasoning_summary_part.done - description: >- - Event type identifier, always "response.reasoning_summary_part.done" + description: Event type identifier, always "response.reasoning_summary_part.done" additionalProperties: false required: - - item_id - - output_index - - part - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryPartDone - description: >- - Streaming event for when a reasoning summary part is completed. - "OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta": + - item_id + - output_index + - part + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone + description: Streaming event for when a reasoning summary part is completed. + OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta: type: object properties: delta: @@ -8369,31 +7600,26 @@ components: description: Index position of the output item sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_text.delta default: response.reasoning_summary_text.delta - description: >- - Event type identifier, always "response.reasoning_summary_text.delta" + description: Event type identifier, always "response.reasoning_summary_text.delta" additionalProperties: false required: - - delta - - item_id - - output_index - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta - description: >- - Streaming event for incremental reasoning summary text updates. - "OpenAIResponseObjectStreamResponseReasoningSummaryTextDone": + - delta + - item_id + - output_index + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta + description: Streaming event for incremental reasoning summary text updates. + OpenAIResponseObjectStreamResponseReasoningSummaryTextDone: type: object properties: text: @@ -8407,111 +7633,92 @@ components: description: Index position of the output item sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events summary_index: type: integer - description: >- - Index of the summary part within the reasoning summary + description: Index of the summary part within the reasoning summary type: type: string const: response.reasoning_summary_text.done default: response.reasoning_summary_text.done - description: >- - Event type identifier, always "response.reasoning_summary_text.done" + description: Event type identifier, always "response.reasoning_summary_text.done" additionalProperties: false required: - - text - - item_id - - output_index - - sequence_number - - summary_index - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningSummaryTextDone - description: >- - Streaming event for when reasoning summary text is completed. - "OpenAIResponseObjectStreamResponseReasoningTextDelta": + - text + - item_id + - output_index + - sequence_number + - summary_index + - type + title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone + description: Streaming event for when reasoning summary text is completed. + OpenAIResponseObjectStreamResponseReasoningTextDelta: type: object properties: content_index: type: integer - description: >- - Index position of the reasoning content part + description: Index position of the reasoning content part delta: type: string description: Incremental reasoning text being added item_id: type: string - description: >- - Unique identifier of the output item being updated + description: Unique identifier of the output item being updated output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.reasoning_text.delta default: response.reasoning_text.delta - description: >- - Event type identifier, always "response.reasoning_text.delta" + description: Event type identifier, always "response.reasoning_text.delta" additionalProperties: false required: - - content_index - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningTextDelta - description: >- - Streaming event for incremental reasoning text updates. - "OpenAIResponseObjectStreamResponseReasoningTextDone": + - content_index + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseReasoningTextDelta + description: Streaming event for incremental reasoning text updates. + OpenAIResponseObjectStreamResponseReasoningTextDone: type: object properties: content_index: type: integer - description: >- - Index position of the reasoning content part + description: Index position of the reasoning content part text: type: string description: Final complete reasoning text item_id: type: string - description: >- - Unique identifier of the completed output item + description: Unique identifier of the completed output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.reasoning_text.done default: response.reasoning_text.done - description: >- - Event type identifier, always "response.reasoning_text.done" + description: Event type identifier, always "response.reasoning_text.done" additionalProperties: false required: - - content_index - - text - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseReasoningTextDone - description: >- - Streaming event for when reasoning text is completed. - "OpenAIResponseObjectStreamResponseRefusalDelta": + - content_index + - text + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseReasoningTextDone + description: Streaming event for when reasoning text is completed. + OpenAIResponseObjectStreamResponseRefusalDelta: type: object properties: content_index: @@ -8525,31 +7732,26 @@ components: description: Unique identifier of the output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.refusal.delta default: response.refusal.delta - description: >- - Event type identifier, always "response.refusal.delta" + description: Event type identifier, always "response.refusal.delta" additionalProperties: false required: - - content_index - - delta - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseRefusalDelta - description: >- - Streaming event for incremental refusal text updates. - "OpenAIResponseObjectStreamResponseRefusalDone": + - content_index + - delta + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseRefusalDelta + description: Streaming event for incremental refusal text updates. + OpenAIResponseObjectStreamResponseRefusalDone: type: object properties: content_index: @@ -8563,62 +7765,51 @@ components: description: Unique identifier of the output item output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.refusal.done default: response.refusal.done - description: >- - Event type identifier, always "response.refusal.done" + description: Event type identifier, always "response.refusal.done" additionalProperties: false required: - - content_index - - refusal - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseRefusalDone - description: >- - Streaming event for when refusal text is completed. - "OpenAIResponseObjectStreamResponseWebSearchCallCompleted": + - content_index + - refusal + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseRefusalDone + description: Streaming event for when refusal text is completed. + OpenAIResponseObjectStreamResponseWebSearchCallCompleted: type: object properties: item_id: type: string - description: >- - Unique identifier of the completed web search call + description: Unique identifier of the completed web search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.web_search_call.completed default: response.web_search_call.completed - description: >- - Event type identifier, always "response.web_search_call.completed" + description: Event type identifier, always "response.web_search_call.completed" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseWebSearchCallCompleted - description: >- - Streaming event for completed web search calls. - "OpenAIResponseObjectStreamResponseWebSearchCallInProgress": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted + description: Streaming event for completed web search calls. + OpenAIResponseObjectStreamResponseWebSearchCallInProgress: type: object properties: item_id: @@ -8626,29 +7817,24 @@ components: description: Unique identifier of the web search call output_index: type: integer - description: >- - Index position of the item in the output list + description: Index position of the item in the output list sequence_number: type: integer - description: >- - Sequential number for ordering streaming events + description: Sequential number for ordering streaming events type: type: string const: response.web_search_call.in_progress default: response.web_search_call.in_progress - description: >- - Event type identifier, always "response.web_search_call.in_progress" + description: Event type identifier, always "response.web_search_call.in_progress" additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseWebSearchCallInProgress - description: >- - Streaming event for web search calls in progress. - "OpenAIResponseObjectStreamResponseWebSearchCallSearching": + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress + description: Streaming event for web search calls in progress. + OpenAIResponseObjectStreamResponseWebSearchCallSearching: type: object properties: item_id: @@ -8663,37 +7849,33 @@ components: default: response.web_search_call.searching additionalProperties: false required: - - item_id - - output_index - - sequence_number - - type - title: >- - OpenAIResponseObjectStreamResponseWebSearchCallSearching + - item_id + - output_index + - sequence_number + - type + title: OpenAIResponseObjectStreamResponseWebSearchCallSearching OpenAIDeleteResponseObject: type: object properties: id: type: string - description: >- - Unique identifier of the deleted response + description: Unique identifier of the deleted response object: type: string const: response default: response - description: >- - Object type identifier, always "response" + description: Object type identifier, always "response" deleted: type: boolean default: true description: Deletion confirmation flag, always True additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: OpenAIDeleteResponseObject - description: >- - Response object confirming deletion of an OpenAI response. + description: Response object confirming deletion of an OpenAI response. ListOpenAIResponseInputItem: type: object properties: @@ -8709,11 +7891,10 @@ components: description: Object type identifier, always "list" additionalProperties: false required: - - data - - object + - data + - object title: ListOpenAIResponseInputItem - description: >- - List container for OpenAI response input items. + description: List container for OpenAI response input items. RunShieldRequest: type: object properties: @@ -8729,26 +7910,25 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The parameters of the shield. additionalProperties: false required: - - shield_id - - messages - - params + - shield_id + - messages + - params title: RunShieldRequest RunShieldResponse: type: object properties: violation: $ref: '#/components/schemas/SafetyViolation' - description: >- - (Optional) Safety violation detected by the shield, if any + description: (Optional) Safety violation detected by the shield, if any additionalProperties: false title: RunShieldResponse description: Response from running a safety shield. @@ -8760,47 +7940,43 @@ components: description: Severity level of the violation user_message: type: string - description: >- - (Optional) Message to convey to the user about the violation + description: (Optional) Message to convey to the user about the violation metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Additional metadata including specific violation codes for debugging and - telemetry + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Additional metadata including specific violation codes for + debugging and telemetry additionalProperties: false required: - - violation_level - - metadata + - violation_level + - metadata title: SafetyViolation - description: >- - Details of a safety violation detected by content moderation. + description: Details of a safety violation detected by content moderation. ViolationLevel: type: string enum: - - info - - warn - - error + - info + - warn + - error title: ViolationLevel description: Severity level of a safety violation. AggregationFunctionType: type: string enum: - - average - - weighted_average - - median - - categorical_count - - accuracy + - average + - weighted_average + - median + - categorical_count + - accuracy title: AggregationFunctionType - description: >- - Types of aggregation functions for scoring results. + description: Types of aggregation functions for scoring results. ArrayType: type: object properties: @@ -8811,7 +7987,7 @@ components: description: Discriminator type. Always "array" additionalProperties: false required: - - type + - type title: ArrayType description: Parameter type for array values. BasicScoringFnParams: @@ -8821,21 +7997,18 @@ components: $ref: '#/components/schemas/ScoringFnParamsType' const: basic default: basic - description: >- - The type of scoring function parameters, always basic + description: The type of scoring function parameters, always basic aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' - description: >- - Aggregation functions to apply to the scores of each row + description: Aggregation functions to apply to the scores of each row additionalProperties: false required: - - type - - aggregation_functions + - type + - aggregation_functions title: BasicScoringFnParams - description: >- - Parameters for basic scoring function configuration. + description: Parameters for basic scoring function configuration. BooleanType: type: object properties: @@ -8846,7 +8019,7 @@ components: description: Discriminator type. Always "boolean" additionalProperties: false required: - - type + - type title: BooleanType description: Parameter type for boolean values. ChatCompletionInputType: @@ -8856,14 +8029,12 @@ components: type: string const: chat_completion_input default: chat_completion_input - description: >- - Discriminator type. Always "chat_completion_input" + description: Discriminator type. Always "chat_completion_input" additionalProperties: false required: - - type + - type title: ChatCompletionInputType - description: >- - Parameter type for chat completion input. + description: Parameter type for chat completion input. CompletionInputType: type: object properties: @@ -8871,11 +8042,10 @@ components: type: string const: completion_input default: completion_input - description: >- - Discriminator type. Always "completion_input" + description: Discriminator type. Always "completion_input" additionalProperties: false required: - - type + - type title: CompletionInputType description: Parameter type for completion input. JsonType: @@ -8888,7 +8058,7 @@ components: description: Discriminator type. Always "json" additionalProperties: false required: - - type + - type title: JsonType description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: @@ -8898,37 +8068,31 @@ components: $ref: '#/components/schemas/ScoringFnParamsType' const: llm_as_judge default: llm_as_judge - description: >- - The type of scoring function parameters, always llm_as_judge + description: The type of scoring function parameters, always llm_as_judge judge_model: type: string - description: >- - Identifier of the LLM model to use as a judge for scoring + description: Identifier of the LLM model to use as a judge for scoring prompt_template: type: string - description: >- - (Optional) Custom prompt template for the judge model + description: (Optional) Custom prompt template for the judge model judge_score_regexes: type: array items: type: string - description: >- - Regexes to extract the answer from generated response + description: Regexes to extract the answer from generated response aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' - description: >- - Aggregation functions to apply to the scores of each row + description: Aggregation functions to apply to the scores of each row additionalProperties: false required: - - type - - judge_model - - judge_score_regexes - - aggregation_functions + - type + - judge_model + - judge_score_regexes + - aggregation_functions title: LLMAsJudgeScoringFnParams - description: >- - Parameters for LLM-as-judge scoring function configuration. + description: Parameters for LLM-as-judge scoring function configuration. NumberType: type: object properties: @@ -8939,7 +8103,7 @@ components: description: Discriminator type. Always "number" additionalProperties: false required: - - type + - type title: NumberType description: Parameter type for numeric values. ObjectType: @@ -8952,7 +8116,7 @@ components: description: Discriminator type. Always "object" additionalProperties: false required: - - type + - type title: ObjectType description: Parameter type for object values. RegexParserScoringFnParams: @@ -8962,28 +8126,24 @@ components: $ref: '#/components/schemas/ScoringFnParamsType' const: regex_parser default: regex_parser - description: >- - The type of scoring function parameters, always regex_parser + description: The type of scoring function parameters, always regex_parser parsing_regexes: type: array items: type: string - description: >- - Regex to extract the answer from generated response + description: Regex to extract the answer from generated response aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' - description: >- - Aggregation functions to apply to the scores of each row + description: Aggregation functions to apply to the scores of each row additionalProperties: false required: - - type - - parsing_regexes - - aggregation_functions + - type + - parsing_regexes + - aggregation_functions title: RegexParserScoringFnParams - description: >- - Parameters for regex parser scoring function configuration. + description: Parameters for regex parser scoring function configuration. ScoringFn: type: object properties: @@ -8996,42 +8156,41 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: scoring_function default: scoring_function - description: >- - The resource type, always scoring_function + description: The resource type, always scoring_function description: type: string metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object return_type: oneOf: - - $ref: '#/components/schemas/StringType' - - $ref: '#/components/schemas/NumberType' - - $ref: '#/components/schemas/BooleanType' - - $ref: '#/components/schemas/ArrayType' - - $ref: '#/components/schemas/ObjectType' - - $ref: '#/components/schemas/JsonType' - - $ref: '#/components/schemas/UnionType' - - $ref: '#/components/schemas/ChatCompletionInputType' - - $ref: '#/components/schemas/CompletionInputType' + - $ref: '#/components/schemas/StringType' + - $ref: '#/components/schemas/NumberType' + - $ref: '#/components/schemas/BooleanType' + - $ref: '#/components/schemas/ArrayType' + - $ref: '#/components/schemas/ObjectType' + - $ref: '#/components/schemas/JsonType' + - $ref: '#/components/schemas/UnionType' + - $ref: '#/components/schemas/ChatCompletionInputType' + - $ref: '#/components/schemas/CompletionInputType' discriminator: propertyName: type mapping: @@ -9048,19 +8207,18 @@ components: $ref: '#/components/schemas/ScoringFnParams' additionalProperties: false required: - - identifier - - provider_id - - type - - metadata - - return_type + - identifier + - provider_id + - type + - metadata + - return_type title: ScoringFn - description: >- - A scoring function resource for evaluating model outputs. + description: A scoring function resource for evaluating model outputs. ScoringFnParams: oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - - $ref: '#/components/schemas/RegexParserScoringFnParams' - - $ref: '#/components/schemas/BasicScoringFnParams' + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + - $ref: '#/components/schemas/RegexParserScoringFnParams' + - $ref: '#/components/schemas/BasicScoringFnParams' discriminator: propertyName: type mapping: @@ -9070,12 +8228,11 @@ components: ScoringFnParamsType: type: string enum: - - llm_as_judge - - regex_parser - - basic + - llm_as_judge + - regex_parser + - basic title: ScoringFnParamsType - description: >- - Types of scoring function parameter configurations. + description: Types of scoring function parameter configurations. StringType: type: object properties: @@ -9086,7 +8243,7 @@ components: description: Discriminator type. Always "string" additionalProperties: false required: - - type + - type title: StringType description: Parameter type for string values. UnionType: @@ -9099,7 +8256,7 @@ components: description: Discriminator type. Always "union" additionalProperties: false required: - - type + - type title: UnionType description: Parameter type for union values. ListScoringFunctionsResponse: @@ -9111,19 +8268,19 @@ components: $ref: '#/components/schemas/ScoringFn' additionalProperties: false required: - - data + - data title: ListScoringFunctionsResponse ParamType: oneOf: - - $ref: '#/components/schemas/StringType' - - $ref: '#/components/schemas/NumberType' - - $ref: '#/components/schemas/BooleanType' - - $ref: '#/components/schemas/ArrayType' - - $ref: '#/components/schemas/ObjectType' - - $ref: '#/components/schemas/JsonType' - - $ref: '#/components/schemas/UnionType' - - $ref: '#/components/schemas/ChatCompletionInputType' - - $ref: '#/components/schemas/CompletionInputType' + - $ref: '#/components/schemas/StringType' + - $ref: '#/components/schemas/NumberType' + - $ref: '#/components/schemas/BooleanType' + - $ref: '#/components/schemas/ArrayType' + - $ref: '#/components/schemas/ObjectType' + - $ref: '#/components/schemas/JsonType' + - $ref: '#/components/schemas/UnionType' + - $ref: '#/components/schemas/ChatCompletionInputType' + - $ref: '#/components/schemas/CompletionInputType' discriminator: propertyName: type mapping: @@ -9141,8 +8298,7 @@ components: properties: scoring_fn_id: type: string - description: >- - The ID of the scoring function to register. + description: The ID of the scoring function to register. description: type: string description: The description of the scoring function. @@ -9151,22 +8307,20 @@ components: description: The return type of the scoring function. provider_scoring_fn_id: type: string - description: >- - The ID of the provider scoring function to use for the scoring function. + description: The ID of the provider scoring function to use for the scoring + function. provider_id: type: string - description: >- - The ID of the provider to use for the scoring function. + description: The ID of the provider to use for the scoring function. params: $ref: '#/components/schemas/ScoringFnParams' - description: >- - The parameters for the scoring function for benchmark eval, these can - be overridden for app eval. + description: The parameters for the scoring function for benchmark eval, + these can be overridden for app eval. additionalProperties: false required: - - scoring_fn_id - - description - - return_type + - scoring_fn_id + - description + - return_type title: RegisterScoringFunctionRequest ScoreRequest: type: object @@ -9177,25 +8331,24 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The rows to score. scoring_functions: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/ScoringFnParams' - - type: 'null' - description: >- - The scoring functions to use for the scoring. + - $ref: '#/components/schemas/ScoringFnParams' + - type: 'null' + description: The scoring functions to use for the scoring. additionalProperties: false required: - - input_rows - - scoring_functions + - input_rows + - scoring_functions title: ScoreRequest ScoreResponse: type: object @@ -9204,11 +8357,10 @@ components: type: object additionalProperties: $ref: '#/components/schemas/ScoringResult' - description: >- - A map of scoring function name to ScoringResult. + description: A map of scoring function name to ScoringResult. additionalProperties: false required: - - results + - results title: ScoreResponse description: The response from scoring. ScoringResult: @@ -9220,29 +8372,29 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The scoring result for each row. Each row is a map of column name to value. - aggregated_results: - type: object - additionalProperties: - oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object + description: The scoring result for each row. Each row is a map of column + name to value. + aggregated_results: + type: object + additionalProperties: + oneOf: + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Map of metric name to aggregated value additionalProperties: false required: - - score_rows - - aggregated_results + - score_rows + - aggregated_results title: ScoringResult description: A scoring result for a single row. ScoreBatchRequest: @@ -9255,39 +8407,34 @@ components: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/ScoringFnParams' - - type: 'null' - description: >- - The scoring functions to use for the scoring. + - $ref: '#/components/schemas/ScoringFnParams' + - type: 'null' + description: The scoring functions to use for the scoring. save_results_dataset: type: boolean - description: >- - Whether to save the results to a dataset. + description: Whether to save the results to a dataset. additionalProperties: false required: - - dataset_id - - scoring_functions - - save_results_dataset + - dataset_id + - scoring_functions + - save_results_dataset title: ScoreBatchRequest ScoreBatchResponse: type: object properties: dataset_id: type: string - description: >- - (Optional) The identifier of the dataset that was scored + description: (Optional) The identifier of the dataset that was scored results: type: object additionalProperties: $ref: '#/components/schemas/ScoringResult' - description: >- - A map of scoring function name to ScoringResult + description: A map of scoring function name to ScoringResult additionalProperties: false required: - - results + - results title: ScoreBatchResponse - description: >- - Response from batch scoring operations on datasets. + description: Response from batch scoring operations on datasets. Shield: type: object properties: @@ -9300,15 +8447,15 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: shield default: shield description: The resource type, always shield @@ -9316,22 +8463,20 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Configuration parameters for the shield + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Configuration parameters for the shield additionalProperties: false required: - - identifier - - provider_id - - type + - identifier + - provider_id + - type title: Shield - description: >- - A safety shield resource that can be used to check content. + description: A safety shield resource that can be used to check content. ListShieldsResponse: type: object properties: @@ -9341,19 +8486,17 @@ components: $ref: '#/components/schemas/Shield' additionalProperties: false required: - - data + - data title: ListShieldsResponse RegisterShieldRequest: type: object properties: shield_id: type: string - description: >- - The identifier of the shield to register. + description: The identifier of the shield to register. provider_shield_id: type: string - description: >- - The identifier of the shield in the provider. + description: The identifier of the shield in the provider. provider_id: type: string description: The identifier of the provider. @@ -9361,16 +8504,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The parameters of the shield. additionalProperties: false required: - - shield_id + - shield_id title: RegisterShieldRequest InvokeToolRequest: type: object @@ -9382,18 +8525,17 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - A dictionary of arguments to pass to the tool. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: A dictionary of arguments to pass to the tool. additionalProperties: false required: - - tool_name - - kwargs + - tool_name + - kwargs title: InvokeToolRequest ImageContentItem: type: object @@ -9402,40 +8544,37 @@ components: type: string const: image default: image - description: >- - Discriminator type of the content item. Always "image" + description: Discriminator type of the content item. Always "image" image: type: object properties: url: $ref: '#/components/schemas/URL' - description: >- - A URL of the image or data URL in the format of data:image/{type};base64,{data}. + description: A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits. data: type: string contentEncoding: base64 description: base64 encoded image data as string additionalProperties: false - description: >- - Image as a base64 encoded string or an URL + description: Image as a base64 encoded string or an URL additionalProperties: false required: - - type - - image + - type + - image title: ImageContentItem description: A image content item InterleavedContent: oneOf: - - type: string - - $ref: '#/components/schemas/InterleavedContentItem' - - type: array - items: - $ref: '#/components/schemas/InterleavedContentItem' + - type: string + - $ref: '#/components/schemas/InterleavedContentItem' + - type: array + items: + $ref: '#/components/schemas/InterleavedContentItem' InterleavedContentItem: oneOf: - - $ref: '#/components/schemas/ImageContentItem' - - $ref: '#/components/schemas/TextContentItem' + - $ref: '#/components/schemas/ImageContentItem' + - $ref: '#/components/schemas/TextContentItem' discriminator: propertyName: type mapping: @@ -9448,15 +8587,14 @@ components: type: string const: text default: text - description: >- - Discriminator type of the content item. Always "text" + description: Discriminator type of the content item. Always "text" text: type: string description: Text content additionalProperties: false required: - - type - - text + - type + - text title: TextContentItem description: A text content item ToolInvocationResult: @@ -9464,28 +8602,24 @@ components: properties: content: $ref: '#/components/schemas/InterleavedContent' - description: >- - (Optional) The output content from the tool execution + description: (Optional) The output content from the tool execution error_message: type: string - description: >- - (Optional) Error message if the tool execution failed + description: (Optional) Error message if the tool execution failed error_code: type: integer - description: >- - (Optional) Numeric error code if the tool execution failed + description: (Optional) Numeric error code if the tool execution failed metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional metadata about the tool execution + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional metadata about the tool execution additionalProperties: false title: ToolInvocationResult description: Result of a tool invocation. @@ -9497,7 +8631,7 @@ components: description: The URL string pointing to the resource additionalProperties: false required: - - uri + - uri title: URL description: A URL reference to external content. ToolDef: @@ -9505,57 +8639,51 @@ components: properties: toolgroup_id: type: string - description: >- - (Optional) ID of the tool group this tool belongs to + description: (Optional) ID of the tool group this tool belongs to name: type: string description: Name of the tool description: type: string - description: >- - (Optional) Human-readable description of what the tool does + description: (Optional) Human-readable description of what the tool does input_schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) JSON Schema for tool inputs (MCP inputSchema) + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) JSON Schema for tool inputs (MCP inputSchema) output_schema: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) JSON Schema for tool outputs (MCP outputSchema) + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) JSON Schema for tool outputs (MCP outputSchema) metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional metadata about the tool + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional metadata about the tool additionalProperties: false required: - - name + - name title: ToolDef - description: >- - Tool definition used in runtime contexts. + description: Tool definition used in runtime contexts. ListToolDefsResponse: type: object properties: @@ -9566,10 +8694,9 @@ components: description: List of tool definitions additionalProperties: false required: - - data + - data title: ListToolDefsResponse - description: >- - Response containing a list of tool definitions. + description: Response containing a list of tool definitions. ToolGroup: type: object properties: @@ -9582,42 +8709,39 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: tool_group default: tool_group description: Type of resource, always 'tool_group' mcp_endpoint: $ref: '#/components/schemas/URL' - description: >- - (Optional) Model Context Protocol endpoint for remote tools + description: (Optional) Model Context Protocol endpoint for remote tools args: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Additional arguments for the tool group + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Additional arguments for the tool group additionalProperties: false required: - - identifier - - provider_id - - type + - identifier + - provider_id + - type title: ToolGroup - description: >- - A group of related tools managed together. + description: A group of related tools managed together. ListToolGroupsResponse: type: object properties: @@ -9628,10 +8752,9 @@ components: description: List of tool groups additionalProperties: false required: - - data + - data title: ListToolGroupsResponse - description: >- - Response containing a list of tool groups. + description: Response containing a list of tool groups. RegisterToolGroupRequest: type: object properties: @@ -9640,163 +8763,142 @@ components: description: The ID of the tool group to register. provider_id: type: string - description: >- - The ID of the provider to use for the tool group. + description: The ID of the provider to use for the tool group. mcp_endpoint: $ref: '#/components/schemas/URL' - description: >- - The MCP endpoint to use for the tool group. + description: The MCP endpoint to use for the tool group. args: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - A dictionary of arguments to pass to the tool group. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: A dictionary of arguments to pass to the tool group. additionalProperties: false required: - - toolgroup_id - - provider_id + - toolgroup_id + - provider_id title: RegisterToolGroupRequest Chunk: type: object properties: content: $ref: '#/components/schemas/InterleavedContent' - description: >- - The content of the chunk, which can be interleaved text, images, or other - types. + description: The content of the chunk, which can be interleaved text, images, + or other types. chunk_id: type: string - description: >- - Unique identifier for the chunk. Must be provided explicitly. + description: Unique identifier for the chunk. Must be provided explicitly. metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Metadata associated with the chunk that will be used in the model context - during inference. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Metadata associated with the chunk that will be used in the + model context during inference. embedding: type: array items: type: number - description: >- - Optional embedding for the chunk. If not provided, it will be computed - later. + description: Optional embedding for the chunk. If not provided, it will + be computed later. chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' - description: >- - Metadata for the chunk that will NOT be used in the context during inference. - The `chunk_metadata` is required backend functionality. + description: Metadata for the chunk that will NOT be used in the context + during inference. The `chunk_metadata` is required backend functionality. additionalProperties: false required: - - content - - chunk_id - - metadata + - content + - chunk_id + - metadata title: Chunk - description: >- - A chunk of content that can be inserted into a vector database. + description: A chunk of content that can be inserted into a vector database. ChunkMetadata: type: object properties: chunk_id: type: string - description: >- - The ID of the chunk. If not set, it will be generated based on the document - ID and content. + description: The ID of the chunk. If not set, it will be generated based + on the document ID and content. document_id: type: string - description: >- - The ID of the document this chunk belongs to. + description: The ID of the document this chunk belongs to. source: type: string - description: >- - The source of the content, such as a URL, file path, or other identifier. + description: The source of the content, such as a URL, file path, or other + identifier. created_timestamp: type: integer - description: >- - An optional timestamp indicating when the chunk was created. + description: An optional timestamp indicating when the chunk was created. updated_timestamp: type: integer - description: >- - An optional timestamp indicating when the chunk was last updated. + description: An optional timestamp indicating when the chunk was last updated. chunk_window: type: string - description: >- - The window of the chunk, which can be used to group related chunks together. + description: The window of the chunk, which can be used to group related + chunks together. chunk_tokenizer: type: string - description: >- - The tokenizer used to create the chunk. Default is Tiktoken. + description: The tokenizer used to create the chunk. Default is Tiktoken. chunk_embedding_model: type: string - description: >- - The embedding model used to create the chunk's embedding. + description: The embedding model used to create the chunk's embedding. chunk_embedding_dimension: type: integer - description: >- - The dimension of the embedding vector for the chunk. + description: The dimension of the embedding vector for the chunk. content_token_count: type: integer - description: >- - The number of tokens in the content of the chunk. + description: The number of tokens in the content of the chunk. metadata_token_count: type: integer - description: >- - The number of tokens in the metadata of the chunk. + description: The number of tokens in the metadata of the chunk. additionalProperties: false 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. + 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.' InsertChunksRequest: type: object properties: vector_store_id: type: string - description: >- - The identifier of the vector database to insert the chunks into. + description: The identifier of the vector database to insert the chunks + into. chunks: type: array items: $ref: '#/components/schemas/Chunk' - description: >- - The chunks to insert. Each `Chunk` should contain content which can be - interleaved text, images, or other types. `metadata`: `dict[str, Any]` - and `embedding`: `List[float]` are optional. If `metadata` is provided, + description: 'The chunks to insert. Each `Chunk` should contain content + which can be interleaved text, images, or other types. `metadata`: `dict[str, + Any]` and `embedding`: `List[float]` are optional. If `metadata` is provided, you configure how Llama Stack formats the chunk during generation. If - `embedding` is not provided, it will be computed later. + `embedding` is not provided, it will be computed later.' ttl_seconds: type: integer description: The time to live of the chunks. additionalProperties: false required: - - vector_store_id - - chunks + - vector_store_id + - chunks title: InsertChunksRequest QueryChunksRequest: type: object properties: vector_store_id: type: string - description: >- - The identifier of the vector database to query. + description: The identifier of the vector database to query. query: $ref: '#/components/schemas/InterleavedContent' description: The query to search for. @@ -9804,17 +8906,17 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The parameters of the query. additionalProperties: false required: - - vector_store_id - - query + - vector_store_id + - query title: QueryChunksRequest QueryChunksResponse: type: object @@ -9823,53 +8925,45 @@ components: type: array items: $ref: '#/components/schemas/Chunk' - description: >- - List of content chunks returned from the query + description: List of content chunks returned from the query scores: type: array items: type: number - description: >- - Relevance scores corresponding to each returned chunk + description: Relevance scores corresponding to each returned chunk additionalProperties: false required: - - chunks - - scores + - chunks + - scores title: QueryChunksResponse - description: >- - Response from querying chunks in a vector database. + description: Response from querying chunks in a vector database. VectorStoreFileCounts: type: object properties: completed: type: integer - description: >- - Number of files that have been successfully processed + description: Number of files that have been successfully processed cancelled: type: integer - description: >- - Number of files that had their processing cancelled + description: Number of files that had their processing cancelled failed: type: integer description: Number of files that failed to process in_progress: type: integer - description: >- - Number of files currently being processed + description: Number of files currently being processed total: type: integer - description: >- - Total number of files in the vector store + description: Total number of files in the vector store additionalProperties: false required: - - completed - - cancelled - - failed - - in_progress - - total + - completed + - cancelled + - failed + - in_progress + - total title: VectorStoreFileCounts - description: >- - File processing status counts for a vector store. + description: File processing status counts for a vector store. VectorStoreListResponse: type: object properties: @@ -9884,22 +8978,20 @@ components: description: List of vector store objects first_id: type: string - description: >- - (Optional) ID of the first vector store in the list for pagination + description: (Optional) ID of the first vector store in the list for pagination last_id: type: string - description: >- - (Optional) ID of the last vector store in the list for pagination + description: (Optional) ID of the last vector store in the list for pagination has_more: type: boolean default: false - description: >- - Whether there are more vector stores available beyond this page + description: Whether there are more vector stores available beyond this + page additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: VectorStoreListResponse description: Response from listing vector stores. VectorStoreObject: @@ -9911,24 +9003,20 @@ components: object: type: string default: vector_store - description: >- - Object type identifier, always "vector_store" + description: Object type identifier, always "vector_store" created_at: type: integer - description: >- - Timestamp when the vector store was created + description: Timestamp when the vector store was created name: type: string description: (Optional) Name of the vector store usage_bytes: type: integer default: 0 - description: >- - Storage space used by the vector store in bytes + description: Storage space used by the vector store in bytes file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' - description: >- - File processing status counts for the vector store + description: File processing status counts for the vector store status: type: string default: completed @@ -9937,49 +9025,45 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Expiration policy for the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Expiration policy for the vector store expires_at: type: integer - description: >- - (Optional) Timestamp when the vector store will expire + description: (Optional) Timestamp when the vector store will expire last_active_at: type: integer - description: >- - (Optional) Timestamp of last activity on the vector store + description: (Optional) Timestamp of last activity on the vector store metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Set of key-value pairs that can be attached to the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Set of key-value pairs that can be attached to the vector store additionalProperties: false required: - - id - - object - - created_at - - usage_bytes - - file_counts - - status - - metadata + - id + - object + - created_at + - usage_bytes + - file_counts + - status + - metadata title: VectorStoreObject description: OpenAI Vector Store object. VectorStoreChunkingStrategy: oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' discriminator: propertyName: type mapping: @@ -9992,14 +9076,12 @@ components: type: string const: auto default: auto - description: >- - Strategy type, always "auto" for automatic chunking + description: Strategy type, always "auto" for automatic chunking additionalProperties: false required: - - type + - type title: VectorStoreChunkingStrategyAuto - description: >- - Automatic chunking strategy for vector store files. + description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: type: object properties: @@ -10007,40 +9089,35 @@ components: type: string const: static default: static - description: >- - Strategy type, always "static" for static chunking + description: Strategy type, always "static" for static chunking static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - description: >- - Configuration parameters for the static chunking strategy + description: Configuration parameters for the static chunking strategy additionalProperties: false required: - - type - - static + - type + - static title: VectorStoreChunkingStrategyStatic - description: >- - Static chunking strategy with configurable parameters. + description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: type: object properties: chunk_overlap_tokens: type: integer default: 400 - description: >- - Number of tokens to overlap between adjacent chunks + description: Number of tokens to overlap between adjacent chunks max_chunk_size_tokens: type: integer default: 800 - description: >- - Maximum number of tokens per chunk, must be between 100 and 4096 + description: Maximum number of tokens per chunk, must be between 100 and + 4096 additionalProperties: false required: - - chunk_overlap_tokens - - max_chunk_size_tokens + - chunk_overlap_tokens + - max_chunk_size_tokens title: VectorStoreChunkingStrategyStaticConfig - description: >- - Configuration for static chunking strategy. - "OpenAICreateVectorStoreRequestWithExtraBody": + description: Configuration for static chunking strategy. + OpenAICreateVectorStoreRequestWithExtraBody: type: object properties: name: @@ -10050,41 +9127,35 @@ components: type: array items: type: string - description: >- - List of file IDs to include in the vector store + description: List of file IDs to include in the vector store expires_after: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Expiration policy for the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Expiration policy for the vector store chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' - description: >- - (Optional) Strategy for splitting files into chunks + description: (Optional) Strategy for splitting files into chunks metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Set of key-value pairs that can be attached to the vector store + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Set of key-value pairs that can be attached to the vector store additionalProperties: false - title: >- - OpenAICreateVectorStoreRequestWithExtraBody - description: >- - Request to create a vector store with extra_body support. + title: OpenAICreateVectorStoreRequestWithExtraBody + description: Request to create a vector store with extra_body support. OpenaiUpdateVectorStoreRequest: type: object properties: @@ -10095,26 +9166,24 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The expiration policy for a vector store. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The expiration policy for a vector store. metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Set of 16 key-value pairs that can be attached to an object. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Set of 16 key-value pairs that can be attached to an object. additionalProperties: false title: OpenaiUpdateVectorStoreRequest VectorStoreDeleteResponse: @@ -10122,58 +9191,50 @@ components: properties: id: type: string - description: >- - Unique identifier of the deleted vector store + description: Unique identifier of the deleted vector store object: type: string default: vector_store.deleted - description: >- - Object type identifier for the deletion response + description: Object type identifier for the deletion response deleted: type: boolean default: true - description: >- - Whether the deletion operation was successful + description: Whether the deletion operation was successful additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: VectorStoreDeleteResponse description: Response from deleting a vector store. - "OpenAICreateVectorStoreFileBatchRequestWithExtraBody": + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: type: object properties: file_ids: type: array items: type: string - description: >- - A list of File IDs that the vector store should use + description: A list of File IDs that the vector store should use attributes: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Key-value attributes to store with the files + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Key-value attributes to store with the files chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' - description: >- - (Optional) The chunking strategy used to chunk the file(s). Defaults to - auto + description: (Optional) The chunking strategy used to chunk the file(s). + Defaults to auto additionalProperties: false required: - - file_ids - title: >- - OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: >- - Request to create a vector store file batch with extra_body support. + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: type: object properties: @@ -10183,66 +9244,58 @@ components: object: type: string default: vector_store.file_batch - description: >- - Object type identifier, always "vector_store.file_batch" + description: Object type identifier, always "vector_store.file_batch" created_at: type: integer - description: >- - Timestamp when the file batch was created + description: Timestamp when the file batch was created vector_store_id: type: string - description: >- - ID of the vector store containing the file batch + description: ID of the vector store containing the file batch status: $ref: '#/components/schemas/VectorStoreFileStatus' - description: >- - Current processing status of the file batch + description: Current processing status of the file batch file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' - description: >- - File processing status counts for the batch + description: File processing status counts for the batch additionalProperties: false required: - - id - - object - - created_at - - vector_store_id - - status - - file_counts + - id + - object + - created_at + - vector_store_id + - status + - file_counts title: VectorStoreFileBatchObject description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: oneOf: - - type: string - const: completed - - type: string - const: in_progress - - type: string - const: cancelled - - type: string - const: failed + - type: string + const: completed + - type: string + const: in_progress + - type: string + const: cancelled + - type: string + const: failed VectorStoreFileLastError: type: object properties: code: oneOf: - - type: string - const: server_error - - type: string - const: rate_limit_exceeded - description: >- - Error code indicating the type of failure + - type: string + const: server_error + - type: string + const: rate_limit_exceeded + description: Error code indicating the type of failure message: type: string - description: >- - Human-readable error message describing the failure + description: Human-readable error message describing the failure additionalProperties: false required: - - code - - message + - code + - message title: VectorStoreFileLastError - description: >- - Error information for failed vector store file processing. + description: Error information for failed vector store file processing. VectorStoreFileObject: type: object properties: @@ -10252,39 +9305,34 @@ components: object: type: string default: vector_store.file - description: >- - Object type identifier, always "vector_store.file" + description: Object type identifier, always "vector_store.file" attributes: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Key-value attributes associated with the file + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Key-value attributes associated with the file chunking_strategy: oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - description: >- - Strategy used for splitting the file into chunks + description: Strategy used for splitting the file into chunks created_at: type: integer - description: >- - Timestamp when the file was added to the vector store + description: Timestamp when the file was added to the vector store last_error: $ref: '#/components/schemas/VectorStoreFileLastError' - description: >- - (Optional) Error information if file processing failed + description: (Optional) Error information if file processing failed status: $ref: '#/components/schemas/VectorStoreFileStatus' description: Current processing status of the file @@ -10294,18 +9342,17 @@ components: description: Storage space used by this file in bytes vector_store_id: type: string - description: >- - ID of the vector store containing this file + description: ID of the vector store containing this file additionalProperties: false required: - - id - - object - - attributes - - chunking_strategy - - created_at - - status - - usage_bytes - - vector_store_id + - id + - object + - attributes + - chunking_strategy + - created_at + - status + - usage_bytes + - vector_store_id title: VectorStoreFileObject description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: @@ -10319,29 +9366,24 @@ components: type: array items: $ref: '#/components/schemas/VectorStoreFileObject' - description: >- - List of vector store file objects in the batch + description: List of vector store file objects in the batch first_id: type: string - description: >- - (Optional) ID of the first file in the list for pagination + description: (Optional) ID of the first file in the list for pagination last_id: type: string - description: >- - (Optional) ID of the last file in the list for pagination + description: (Optional) ID of the last file in the list for pagination has_more: type: boolean default: false - description: >- - Whether there are more files available beyond this page + description: Whether there are more files available beyond this page additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: VectorStoreFilesListInBatchResponse - description: >- - Response from listing files in a vector store file batch. + description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: type: object properties: @@ -10356,51 +9398,45 @@ components: description: List of vector store file objects first_id: type: string - description: >- - (Optional) ID of the first file in the list for pagination + description: (Optional) ID of the first file in the list for pagination last_id: type: string - description: >- - (Optional) ID of the last file in the list for pagination + description: (Optional) ID of the last file in the list for pagination has_more: type: boolean default: false - description: >- - Whether there are more files available beyond this page + description: Whether there are more files available beyond this page additionalProperties: false required: - - object - - data - - has_more + - object + - data + - has_more title: VectorStoreListFilesResponse - description: >- - Response from listing files in a vector store. + description: Response from listing files in a vector store. OpenaiAttachFileToVectorStoreRequest: type: object properties: file_id: type: string - description: >- - The ID of the file to attach to the vector store. + description: The ID of the file to attach to the vector store. attributes: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The key-value attributes stored with the file, which can be used for filtering. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The key-value attributes stored with the file, which can be + used for filtering. chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' - description: >- - The chunking strategy to use for the file. + description: The chunking strategy to use for the file. additionalProperties: false required: - - file_id + - file_id title: OpenaiAttachFileToVectorStoreRequest OpenaiUpdateVectorStoreFileRequest: type: object @@ -10409,17 +9445,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The updated key-value attributes to store with the file. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: The updated key-value attributes to store with the file. additionalProperties: false required: - - attributes + - attributes title: OpenaiUpdateVectorStoreFileRequest VectorStoreFileDeleteResponse: type: object @@ -10430,136 +9465,119 @@ components: object: type: string default: vector_store.file.deleted - description: >- - Object type identifier for the deletion response + description: Object type identifier for the deletion response deleted: type: boolean default: true - description: >- - Whether the deletion operation was successful + description: Whether the deletion operation was successful additionalProperties: false required: - - id - - object - - deleted + - id + - object + - deleted title: VectorStoreFileDeleteResponse - description: >- - Response from deleting a vector store file. + description: Response from deleting a vector store file. VectorStoreContent: type: object properties: type: type: string const: text - description: >- - Content type, currently only "text" is supported + description: Content type, currently only "text" is supported text: type: string description: The actual text content additionalProperties: false required: - - type - - text + - type + - text title: VectorStoreContent - description: >- - Content item from a vector store file or search result. - VectorStoreFileContentsResponse: + description: Content item from a vector store file or search result. + VectorStoreFileContentResponse: type: object + description: Represents the parsed content of a vector store file. properties: - file_id: + object: type: string - description: Unique identifier for the file - filename: - type: string - description: Name of the file - attributes: - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Key-value attributes associated with the file - content: + enum: + - vector_store.file_content.page + description: The object type, which is always `vector_store.file_content.page` + x-stainless-const: true + data: type: array + description: Parsed content of the file. items: $ref: '#/components/schemas/VectorStoreContent' - description: List of content items from the file + has_more: + type: boolean + description: Indicates if there are more content pages to fetch. + next_page: + anyOf: + - type: string + description: The token for the next page, if any. + - type: 'null' additionalProperties: false required: - - file_id - - filename - - attributes - - content - title: VectorStoreFileContentsResponse - description: >- - Response from retrieving the contents of a vector store file. + - object + - data + - has_more + - next_page + title: VectorStoreFileContentResponse OpenaiSearchVectorStoreRequest: type: object properties: query: oneOf: - - type: string - - type: array - items: - type: string - description: >- - The query string or array for performing the search. + - type: string + - type: array + items: + type: string + description: The query string or array for performing the search. filters: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - Filters based on file attributes to narrow the search results. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: Filters based on file attributes to narrow the search results. max_num_results: type: integer - description: >- - Maximum number of results to return (1 to 50 inclusive, default 10). + description: Maximum number of results to return (1 to 50 inclusive, default + 10). ranking_options: type: object properties: ranker: type: string - description: >- - (Optional) Name of the ranking algorithm to use + description: (Optional) Name of the ranking algorithm to use score_threshold: type: number default: 0.0 - description: >- - (Optional) Minimum relevance score threshold for results + description: (Optional) Minimum relevance score threshold for results additionalProperties: false - description: >- - Ranking options for fine-tuning the search results. + description: Ranking options for fine-tuning the search results. rewrite_query: type: boolean - description: >- - Whether to rewrite the natural language query for vector search (default - false) + description: Whether to rewrite the natural language query for vector search + (default false) search_mode: type: string - description: >- - The search mode to use - "keyword", "vector", or "hybrid" (default "vector") + description: The search mode to use - "keyword", "vector", or "hybrid" (default + "vector") additionalProperties: false required: - - query + - query title: OpenaiSearchVectorStoreRequest VectorStoreSearchResponse: type: object properties: file_id: type: string - description: >- - Unique identifier of the file containing the result + description: Unique identifier of the file containing the result filename: type: string description: Name of the file containing the result @@ -10570,23 +9588,21 @@ components: type: object additionalProperties: oneOf: - - type: string - - type: number - - type: boolean - description: >- - (Optional) Key-value attributes associated with the file + - type: string + - type: number + - type: boolean + description: (Optional) Key-value attributes associated with the file content: type: array items: $ref: '#/components/schemas/VectorStoreContent' - description: >- - List of content items matching the search query + description: List of content items matching the search query additionalProperties: false required: - - file_id - - filename - - score - - content + - file_id + - filename + - score + - content title: VectorStoreSearchResponse description: Response from searching a vector store. VectorStoreSearchResponsePage: @@ -10595,14 +9611,12 @@ components: object: type: string default: vector_store.search_results.page - description: >- - Object type identifier for the search results page + description: Object type identifier for the search results page search_query: type: array items: type: string - description: >- - The original search query that was executed + description: The original search query that was executed data: type: array items: @@ -10611,21 +9625,18 @@ components: has_more: type: boolean default: false - description: >- - Whether there are more results available beyond this page + description: Whether there are more results available beyond this page next_page: type: string - description: >- - (Optional) Token for retrieving the next page of results + description: (Optional) Token for retrieving the next page of results additionalProperties: false required: - - object - - search_query - - data - - has_more + - object + - search_query + - data + - has_more title: VectorStoreSearchResponsePage - description: >- - Paginated response from searching a vector store. + description: Paginated response from searching a vector store. VersionInfo: type: object properties: @@ -10634,7 +9645,7 @@ components: description: Version number of the service additionalProperties: false required: - - version + - version title: VersionInfo description: Version information for the service. AppendRowsRequest: @@ -10646,16 +9657,16 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The rows to append to the dataset. additionalProperties: false required: - - rows + - rows title: AppendRowsRequest PaginatedResponse: type: object @@ -10666,27 +9677,25 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The list of items for the current page has_more: type: boolean - description: >- - Whether there are more items available after this set + description: Whether there are more items available after this set url: type: string description: The URL for accessing this list additionalProperties: false required: - - data - - has_more + - data + - has_more title: PaginatedResponse - description: >- - A generic paginated response that follows a simple format. + description: A generic paginated response that follows a simple format. Dataset: type: object properties: @@ -10699,60 +9708,57 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: dataset default: dataset - description: >- - Type of resource, always 'dataset' for datasets + description: Type of resource, always 'dataset' for datasets purpose: type: string enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - description: >- - Purpose of the dataset indicating its intended use + - post-training/messages + - eval/question-answer + - eval/messages-answer + description: Purpose of the dataset indicating its intended use source: oneOf: - - $ref: '#/components/schemas/URIDataSource' - - $ref: '#/components/schemas/RowsDataSource' + - $ref: '#/components/schemas/URIDataSource' + - $ref: '#/components/schemas/RowsDataSource' discriminator: propertyName: type mapping: uri: '#/components/schemas/URIDataSource' rows: '#/components/schemas/RowsDataSource' - description: >- - Data source configuration for the dataset + description: Data source configuration for the dataset metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Additional metadata for the dataset additionalProperties: false required: - - identifier - - provider_id - - type - - purpose - - source - - metadata + - identifier + - provider_id + - type + - purpose + - source + - metadata title: Dataset - description: >- - Dataset resource for storing and accessing training or evaluation data. + description: Dataset resource for storing and accessing training or evaluation + data. RowsDataSource: type: object properties: @@ -10766,20 +9772,19 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The dataset is stored in rows. E.g. - [ {"messages": [{"role": "user", - "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, - world!"}]} ] + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: 'The dataset is stored in rows. E.g. - [ {"messages": [{"role": + "user", "content": "Hello, world!"}, {"role": "assistant", "content": + "Hello, world!"}]} ]' additionalProperties: false required: - - type - - rows + - type + - rows title: RowsDataSource description: A dataset stored in rows. URIDataSource: @@ -10791,16 +9796,14 @@ components: default: uri uri: type: string - description: >- - The dataset can be obtained from a URI. E.g. - "https://mywebsite.com/mydata.jsonl" + description: The dataset can be obtained from a URI. E.g. - "https://mywebsite.com/mydata.jsonl" - "lsfs://mydata.jsonl" - "data:csv;base64,{base64_content}" additionalProperties: false required: - - type - - uri + - type + - uri title: URIDataSource - description: >- - A dataset that can be obtained from a URI. + description: A dataset that can be obtained from a URI. ListDatasetsResponse: type: object properties: @@ -10811,13 +9814,13 @@ components: description: List of datasets additionalProperties: false required: - - data + - data title: ListDatasetsResponse description: Response from listing datasets. DataSource: oneOf: - - $ref: '#/components/schemas/URIDataSource' - - $ref: '#/components/schemas/RowsDataSource' + - $ref: '#/components/schemas/URIDataSource' + - $ref: '#/components/schemas/RowsDataSource' discriminator: propertyName: type mapping: @@ -10829,52 +9832,48 @@ components: purpose: type: string enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - description: >- - The purpose of the dataset. One of: - "post-training/messages": The dataset - contains a messages column with list of messages for post-training. { - "messages": [ {"role": "user", "content": "Hello, world!"}, {"role": "assistant", - "content": "Hello, world!"}, ] } - "eval/question-answer": The dataset - contains a question column and an answer column for evaluation. { "question": - "What is the capital of France?", "answer": "Paris" } - "eval/messages-answer": - The dataset contains a messages column with list of messages and an answer - column for evaluation. { "messages": [ {"role": "user", "content": "Hello, - my name is John Doe."}, {"role": "assistant", "content": "Hello, John - Doe. How can I help you today?"}, {"role": "user", "content": "What's - my name?"}, ], "answer": "John Doe" } + - post-training/messages + - eval/question-answer + - eval/messages-answer + description: 'The purpose of the dataset. One of: - "post-training/messages": + The dataset contains a messages column with list of messages for post-training. + { "messages": [ {"role": "user", "content": "Hello, world!"}, {"role": + "assistant", "content": "Hello, world!"}, ] } - "eval/question-answer": + The dataset contains a question column and an answer column for evaluation. + { "question": "What is the capital of France?", "answer": "Paris" } - + "eval/messages-answer": The dataset contains a messages column with list + of messages and an answer column for evaluation. { "messages": [ {"role": + "user", "content": "Hello, my name is John Doe."}, {"role": "assistant", + "content": "Hello, John Doe. How can I help you today?"}, {"role": "user", + "content": "What''s my name?"}, ], "answer": "John Doe" }' source: $ref: '#/components/schemas/DataSource' - description: >- - The data source of the dataset. Ensure that the data source schema is - compatible with the purpose of the dataset. Examples: - { "type": "uri", - "uri": "https://mywebsite.com/mydata.jsonl" } - { "type": "uri", "uri": - "lsfs://mydata.jsonl" } - { "type": "uri", "uri": "data:csv;base64,{base64_content}" + description: 'The data source of the dataset. Ensure that the data source + schema is compatible with the purpose of the dataset. Examples: - { "type": + "uri", "uri": "https://mywebsite.com/mydata.jsonl" } - { "type": "uri", + "uri": "lsfs://mydata.jsonl" } - { "type": "uri", "uri": "data:csv;base64,{base64_content}" } - { "type": "uri", "uri": "huggingface://llamastack/simpleqa?split=train" } - { "type": "rows", "rows": [ { "messages": [ {"role": "user", "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}, ] - } ] } + } ] }' metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - The metadata for the dataset. - E.g. {"description": "My dataset"}. + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: 'The metadata for the dataset. - E.g. {"description": "My dataset"}.' dataset_id: type: string - description: >- - The ID of the dataset. If not provided, an ID will be generated. + description: The ID of the dataset. If not provided, an ID will be generated. additionalProperties: false required: - - purpose - - source + - purpose + - source title: RegisterDatasetRequest Benchmark: type: object @@ -10888,50 +9887,47 @@ components: type: type: string enum: - - model - - shield - - vector_store - - dataset - - scoring_function - - benchmark - - tool - - tool_group - - prompt + - model + - shield + - vector_store + - dataset + - scoring_function + - benchmark + - tool + - tool_group + - prompt const: benchmark default: benchmark description: The resource type, always benchmark dataset_id: type: string - description: >- - Identifier of the dataset to use for the benchmark evaluation + description: Identifier of the dataset to use for the benchmark evaluation scoring_functions: type: array items: type: string - description: >- - List of scoring function identifiers to apply during evaluation + description: List of scoring function identifiers to apply during evaluation metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: Metadata for this evaluation task additionalProperties: false required: - - identifier - - provider_id - - type - - dataset_id - - scoring_functions - - metadata + - identifier + - provider_id + - type + - dataset_id + - scoring_functions + - metadata title: Benchmark - description: >- - A benchmark resource for evaluating model performance. + description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: type: object properties: @@ -10941,7 +9937,7 @@ components: $ref: '#/components/schemas/Benchmark' additionalProperties: false required: - - data + - data title: ListBenchmarksResponse RegisterBenchmarkRequest: type: object @@ -10951,38 +9947,34 @@ components: description: The ID of the benchmark to register. dataset_id: type: string - description: >- - The ID of the dataset to use for the benchmark. + description: The ID of the dataset to use for the benchmark. scoring_functions: type: array items: type: string - description: >- - The scoring functions to use for the benchmark. + description: The scoring functions to use for the benchmark. provider_benchmark_id: type: string - description: >- - The ID of the provider benchmark to use for the benchmark. + description: The ID of the provider benchmark to use for the benchmark. provider_id: type: string - description: >- - The ID of the provider to use for the benchmark. + description: The ID of the provider to use for the benchmark. metadata: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The metadata to use for the benchmark. additionalProperties: false required: - - benchmark_id - - dataset_id - - scoring_functions + - benchmark_id + - dataset_id + - scoring_functions title: RegisterBenchmarkRequest BenchmarkConfig: type: object @@ -10994,21 +9986,18 @@ components: type: object additionalProperties: $ref: '#/components/schemas/ScoringFnParams' - description: >- - Map between scoring function id and parameters for each scoring function - you want to run + description: Map between scoring function id and parameters for each scoring + function you want to run num_examples: type: integer - description: >- - (Optional) The number of examples to evaluate. If not provided, all examples - in the dataset will be evaluated + description: (Optional) The number of examples to evaluate. If not provided, + all examples in the dataset will be evaluated additionalProperties: false required: - - eval_candidate - - scoring_params + - eval_candidate + - scoring_params title: BenchmarkConfig - description: >- - A benchmark configuration for evaluation. + description: A benchmark configuration for evaluation. GreedySamplingStrategy: type: object properties: @@ -11016,15 +10005,13 @@ components: type: string const: greedy default: greedy - description: >- - Must be "greedy" to identify this sampling strategy + description: Must be "greedy" to identify this sampling strategy additionalProperties: false required: - - type + - type title: GreedySamplingStrategy - description: >- - Greedy sampling strategy that selects the highest probability token at each - step. + description: Greedy sampling strategy that selects the highest probability token + at each step. ModelCandidate: type: object properties: @@ -11040,14 +10027,13 @@ components: description: The sampling parameters for the model. system_message: $ref: '#/components/schemas/SystemMessage' - description: >- - (Optional) The system message providing instructions or context to the - model. + description: (Optional) The system message providing instructions or context + to the model. additionalProperties: false required: - - type - - model - - sampling_params + - type + - model + - sampling_params title: ModelCandidate description: A model candidate for evaluation. SamplingParams: @@ -11055,9 +10041,9 @@ components: properties: strategy: oneOf: - - $ref: '#/components/schemas/GreedySamplingStrategy' - - $ref: '#/components/schemas/TopPSamplingStrategy' - - $ref: '#/components/schemas/TopKSamplingStrategy' + - $ref: '#/components/schemas/GreedySamplingStrategy' + - $ref: '#/components/schemas/TopPSamplingStrategy' + - $ref: '#/components/schemas/TopKSamplingStrategy' discriminator: propertyName: type mapping: @@ -11067,27 +10053,24 @@ components: description: The sampling strategy. max_tokens: type: integer - description: >- - The maximum number of tokens that can be generated in the completion. + description: The maximum number of tokens that can be generated in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length. repetition_penalty: type: number default: 1.0 - description: >- - Number between -2.0 and 2.0. Positive values penalize new tokens based - on whether they appear in the text so far, increasing the model's likelihood - to talk about new topics. + description: Number between -2.0 and 2.0. Positive values penalize new tokens + based on whether they appear in the text so far, increasing the model's + likelihood to talk about new topics. stop: type: array items: type: string - description: >- - Up to 4 sequences where the API will stop generating further tokens. The - returned text will not contain the stop sequence. + description: Up to 4 sequences where the API will stop generating further + tokens. The returned text will not contain the stop sequence. additionalProperties: false required: - - strategy + - strategy title: SamplingParams description: Sampling parameters. SystemMessage: @@ -11097,21 +10080,18 @@ components: type: string const: system default: system - description: >- - Must be "system" to identify this as a system message + description: Must be "system" to identify this as a system message content: $ref: '#/components/schemas/InterleavedContent' - description: >- - The content of the "system prompt". If multiple system messages are provided, - they are concatenated. The underlying Llama Stack code may also add other - system messages (for example, for formatting tool definitions). + description: The content of the "system prompt". If multiple system messages + are provided, they are concatenated. The underlying Llama Stack code may + also add other system messages (for example, for formatting tool definitions). additionalProperties: false required: - - role - - content + - role + - content title: SystemMessage - description: >- - A system message providing instructions or context to the model. + description: A system message providing instructions or context to the model. TopKSamplingStrategy: type: object properties: @@ -11119,19 +10099,18 @@ components: type: string const: top_k default: top_k - description: >- - Must be "top_k" to identify this sampling strategy + description: Must be "top_k" to identify this sampling strategy top_k: type: integer - description: >- - Number of top tokens to consider for sampling. Must be at least 1 + description: Number of top tokens to consider for sampling. Must be at least + 1 additionalProperties: false required: - - type - - top_k + - type + - top_k title: TopKSamplingStrategy - description: >- - Top-k sampling strategy that restricts sampling to the k most likely tokens. + description: Top-k sampling strategy that restricts sampling to the k most likely + tokens. TopPSamplingStrategy: type: object properties: @@ -11139,24 +10118,21 @@ components: type: string const: top_p default: top_p - description: >- - Must be "top_p" to identify this sampling strategy + description: Must be "top_p" to identify this sampling strategy temperature: type: number - description: >- - Controls randomness in sampling. Higher values increase randomness + description: Controls randomness in sampling. Higher values increase randomness top_p: type: number default: 0.95 - description: >- - Cumulative probability threshold for nucleus sampling. Defaults to 0.95 + description: Cumulative probability threshold for nucleus sampling. Defaults + to 0.95 additionalProperties: false required: - - type + - type title: TopPSamplingStrategy - description: >- - Top-p (nucleus) sampling strategy that samples from the smallest set of tokens - with cumulative probability >= p. + description: Top-p (nucleus) sampling strategy that samples from the smallest + set of tokens with cumulative probability >= p. EvaluateRowsRequest: type: object properties: @@ -11166,27 +10142,26 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The rows to evaluate. scoring_functions: type: array items: type: string - description: >- - The scoring functions to use for the evaluation. + description: The scoring functions to use for the evaluation. benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark. additionalProperties: false required: - - input_rows - - scoring_functions - - benchmark_config + - input_rows + - scoring_functions + - benchmark_config title: EvaluateRowsRequest EvaluateResponse: type: object @@ -11197,12 +10172,12 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The generations from the evaluation. scores: type: object @@ -11211,8 +10186,8 @@ components: description: The scores from the evaluation. additionalProperties: false required: - - generations - - scores + - generations + - scores title: EvaluateResponse description: The response from an evaluation. RunEvalRequest: @@ -11223,7 +10198,7 @@ components: description: The configuration for the benchmark. additionalProperties: false required: - - benchmark_config + - benchmark_config title: RunEvalRequest Job: type: object @@ -11234,75 +10209,68 @@ components: status: type: string enum: - - completed - - in_progress - - failed - - scheduled - - cancelled + - completed + - in_progress + - failed + - scheduled + - cancelled description: Current execution status of the job additionalProperties: false required: - - job_id - - status + - job_id + - status title: Job - description: >- - A job execution instance with status tracking. + description: A job execution instance with status tracking. RerankRequest: type: object properties: model: type: string - description: >- - The identifier of the reranking model to use. + description: The identifier of the reranking model to use. query: oneOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - description: >- - The search query to rank items against. Can be a string, text content - part, or image content part. The input must not exceed the model's max - input token length. + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + description: The search query to rank items against. Can be a string, text + content part, or image content part. The input must not exceed the model's + max input token length. items: type: array items: oneOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - description: >- - List of items to rerank. Each item can be a string, text content part, - or image content part. Each input must not exceed the model's max input - token length. + - type: string + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' + description: List of items to rerank. Each item can be a string, text content + part, or image content part. Each input must not exceed the model's max + input token length. max_num_results: type: integer - description: >- - (Optional) Maximum number of results to return. Default: returns all. + description: '(Optional) Maximum number of results to return. Default: returns + all.' additionalProperties: false required: - - model - - query - - items + - model + - query + - items title: RerankRequest RerankData: type: object properties: index: type: integer - description: >- - The original index of the document in the input list + description: The original index of the document in the input list relevance_score: type: number - description: >- - The relevance score from the model output. Values are inverted when applicable - so that higher scores indicate greater relevance. + description: The relevance score from the model output. Values are inverted + when applicable so that higher scores indicate greater relevance. additionalProperties: false required: - - index - - relevance_score + - index + - relevance_score title: RerankData - description: >- - A single rerank result from a reranking response. + description: A single rerank result from a reranking response. RerankResponse: type: object properties: @@ -11310,11 +10278,10 @@ components: type: array items: $ref: '#/components/schemas/RerankData' - description: >- - List of rerank result objects, sorted by relevance score (descending) + description: List of rerank result objects, sorted by relevance score (descending) additionalProperties: false required: - - data + - data title: RerankResponse description: Response from a reranking request. Checkpoint: @@ -11326,31 +10293,26 @@ components: created_at: type: string format: date-time - description: >- - Timestamp when the checkpoint was created + description: Timestamp when the checkpoint was created epoch: type: integer - description: >- - Training epoch when the checkpoint was saved + description: Training epoch when the checkpoint was saved post_training_job_id: type: string - description: >- - Identifier of the training job that created this checkpoint + description: Identifier of the training job that created this checkpoint path: type: string - description: >- - File system path where the checkpoint is stored + description: File system path where the checkpoint is stored training_metrics: $ref: '#/components/schemas/PostTrainingMetric' - description: >- - (Optional) Training metrics associated with this checkpoint + description: (Optional) Training metrics associated with this checkpoint additionalProperties: false required: - - identifier - - created_at - - epoch - - post_training_job_id - - path + - identifier + - created_at + - epoch + - post_training_job_id + - path title: Checkpoint description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: @@ -11363,12 +10325,11 @@ components: type: array items: $ref: '#/components/schemas/Checkpoint' - description: >- - List of model checkpoints created during training + description: List of model checkpoints created during training additionalProperties: false required: - - job_uuid - - checkpoints + - job_uuid + - checkpoints title: PostTrainingJobArtifactsResponse description: Artifacts of a finetuning job. PostTrainingMetric: @@ -11385,17 +10346,15 @@ components: description: Loss value on the validation dataset perplexity: type: number - description: >- - Perplexity metric indicating model confidence + description: Perplexity metric indicating model confidence additionalProperties: false required: - - epoch - - train_loss - - validation_loss - - perplexity + - epoch + - train_loss + - validation_loss + - perplexity title: PostTrainingMetric - description: >- - Training metrics captured during post-training jobs. + description: Training metrics captured during post-training jobs. CancelTrainingJobRequest: type: object properties: @@ -11404,7 +10363,7 @@ components: description: The UUID of the job to cancel. additionalProperties: false required: - - job_uuid + - job_uuid title: CancelTrainingJobRequest PostTrainingJobStatusResponse: type: object @@ -11415,51 +10374,46 @@ components: status: type: string enum: - - completed - - in_progress - - failed - - scheduled - - cancelled + - completed + - in_progress + - failed + - scheduled + - cancelled description: Current status of the training job scheduled_at: type: string format: date-time - description: >- - (Optional) Timestamp when the job was scheduled + description: (Optional) Timestamp when the job was scheduled started_at: type: string format: date-time - description: >- - (Optional) Timestamp when the job execution began + description: (Optional) Timestamp when the job execution began completed_at: type: string format: date-time - description: >- - (Optional) Timestamp when the job finished, if completed + description: (Optional) Timestamp when the job finished, if completed resources_allocated: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: >- - (Optional) Information about computational resources allocated to the - job + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object + description: (Optional) Information about computational resources allocated + to the job checkpoints: type: array items: $ref: '#/components/schemas/Checkpoint' - description: >- - List of model checkpoints created during training + description: List of model checkpoints created during training additionalProperties: false required: - - job_uuid - - status - - checkpoints + - job_uuid + - status + - checkpoints title: PostTrainingJobStatusResponse description: Status of a finetuning job. ListPostTrainingJobsResponse: @@ -11474,11 +10428,11 @@ components: type: string additionalProperties: false required: - - job_uuid + - job_uuid title: PostTrainingJob additionalProperties: false required: - - data + - data title: ListPostTrainingJobsResponse DPOAlignmentConfig: type: object @@ -11492,66 +10446,59 @@ components: description: The type of loss function to use for DPO additionalProperties: false required: - - beta - - loss_type + - beta + - loss_type title: DPOAlignmentConfig - description: >- - Configuration for Direct Preference Optimization (DPO) alignment. + description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: type: string enum: - - sigmoid - - hinge - - ipo - - kto_pair + - sigmoid + - hinge + - ipo + - kto_pair title: DPOLossType DataConfig: type: object properties: dataset_id: type: string - description: >- - Unique identifier for the training dataset + description: Unique identifier for the training dataset batch_size: type: integer description: Number of samples per training batch shuffle: type: boolean - description: >- - Whether to shuffle the dataset during training + description: Whether to shuffle the dataset during training data_format: $ref: '#/components/schemas/DatasetFormat' - description: >- - Format of the dataset (instruct or dialog) + description: Format of the dataset (instruct or dialog) validation_dataset_id: type: string - description: >- - (Optional) Unique identifier for the validation dataset + description: (Optional) Unique identifier for the validation dataset packed: type: boolean default: false - description: >- - (Optional) Whether to pack multiple samples into a single sequence for - efficiency + description: (Optional) Whether to pack multiple samples into a single sequence + for efficiency train_on_input: type: boolean default: false - description: >- - (Optional) Whether to compute loss on input tokens as well as output tokens + description: (Optional) Whether to compute loss on input tokens as well + as output tokens additionalProperties: false required: - - dataset_id - - batch_size - - shuffle - - data_format + - dataset_id + - batch_size + - shuffle + - data_format title: DataConfig - description: >- - Configuration for training data and data loading. + description: Configuration for training data and data loading. DatasetFormat: type: string enum: - - instruct - - dialog + - instruct + - dialog title: DatasetFormat description: Format of the training dataset. EfficiencyConfig: @@ -11560,62 +10507,55 @@ components: enable_activation_checkpointing: type: boolean default: false - description: >- - (Optional) Whether to use activation checkpointing to reduce memory usage + description: (Optional) Whether to use activation checkpointing to reduce + memory usage enable_activation_offloading: type: boolean default: false - description: >- - (Optional) Whether to offload activations to CPU to save GPU memory + description: (Optional) Whether to offload activations to CPU to save GPU + memory memory_efficient_fsdp_wrap: type: boolean default: false - description: >- - (Optional) Whether to use memory-efficient FSDP wrapping + description: (Optional) Whether to use memory-efficient FSDP wrapping fsdp_cpu_offload: type: boolean default: false - description: >- - (Optional) Whether to offload FSDP parameters to CPU + description: (Optional) Whether to offload FSDP parameters to CPU additionalProperties: false title: EfficiencyConfig - description: >- - Configuration for memory and compute efficiency optimizations. + description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: type: object properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' - description: >- - Type of optimizer to use (adam, adamw, or sgd) + description: Type of optimizer to use (adam, adamw, or sgd) lr: type: number description: Learning rate for the optimizer weight_decay: type: number - description: >- - Weight decay coefficient for regularization + description: Weight decay coefficient for regularization num_warmup_steps: type: integer description: Number of steps for learning rate warmup additionalProperties: false required: - - optimizer_type - - lr - - weight_decay - - num_warmup_steps + - optimizer_type + - lr + - weight_decay + - num_warmup_steps title: OptimizerConfig - description: >- - Configuration parameters for the optimization algorithm. + description: Configuration parameters for the optimization algorithm. OptimizerType: type: string enum: - - adam - - adamw - - sgd + - adam + - adamw + - sgd title: OptimizerType - description: >- - Available optimizer algorithms for training. + description: Available optimizer algorithms for training. TrainingConfig: type: object properties: @@ -11629,38 +10569,31 @@ components: gradient_accumulation_steps: type: integer default: 1 - description: >- - Number of steps to accumulate gradients before updating + description: Number of steps to accumulate gradients before updating max_validation_steps: type: integer default: 1 - description: >- - (Optional) Maximum number of validation steps per epoch + description: (Optional) Maximum number of validation steps per epoch data_config: $ref: '#/components/schemas/DataConfig' - description: >- - (Optional) Configuration for data loading and formatting + description: (Optional) Configuration for data loading and formatting optimizer_config: $ref: '#/components/schemas/OptimizerConfig' - description: >- - (Optional) Configuration for the optimization algorithm + description: (Optional) Configuration for the optimization algorithm efficiency_config: $ref: '#/components/schemas/EfficiencyConfig' - description: >- - (Optional) Configuration for memory and compute optimizations + description: (Optional) Configuration for memory and compute optimizations dtype: type: string default: bf16 - description: >- - (Optional) Data type for model parameters (bf16, fp16, fp32) + description: (Optional) Data type for model parameters (bf16, fp16, fp32) additionalProperties: false required: - - n_epochs - - max_steps_per_epoch - - gradient_accumulation_steps + - n_epochs + - max_steps_per_epoch + - gradient_accumulation_steps title: TrainingConfig - description: >- - Comprehensive configuration for the training process. + description: Comprehensive configuration for the training process. PreferenceOptimizeRequest: type: object properties: @@ -11680,32 +10613,32 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The hyperparam search configuration. logger_config: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The logger configuration. additionalProperties: false required: - - job_uuid - - finetuned_model - - algorithm_config - - training_config - - hyperparam_search_config - - logger_config + - job_uuid + - finetuned_model + - algorithm_config + - training_config + - hyperparam_search_config + - logger_config title: PreferenceOptimizeRequest PostTrainingJob: type: object @@ -11714,12 +10647,12 @@ components: type: string additionalProperties: false required: - - job_uuid + - job_uuid title: PostTrainingJob AlgorithmConfig: oneOf: - - $ref: '#/components/schemas/LoraFinetuningConfig' - - $ref: '#/components/schemas/QATFinetuningConfig' + - $ref: '#/components/schemas/LoraFinetuningConfig' + - $ref: '#/components/schemas/QATFinetuningConfig' discriminator: propertyName: type mapping: @@ -11737,44 +10670,38 @@ components: type: array items: type: string - description: >- - List of attention module names to apply LoRA to + description: List of attention module names to apply LoRA to apply_lora_to_mlp: type: boolean description: Whether to apply LoRA to MLP layers apply_lora_to_output: type: boolean - description: >- - Whether to apply LoRA to output projection layers + description: Whether to apply LoRA to output projection layers rank: type: integer - description: >- - Rank of the LoRA adaptation (lower rank = fewer parameters) + description: Rank of the LoRA adaptation (lower rank = fewer parameters) alpha: type: integer - description: >- - LoRA scaling parameter that controls adaptation strength + description: LoRA scaling parameter that controls adaptation strength use_dora: type: boolean default: false - description: >- - (Optional) Whether to use DoRA (Weight-Decomposed Low-Rank Adaptation) + description: (Optional) Whether to use DoRA (Weight-Decomposed Low-Rank + Adaptation) quantize_base: type: boolean default: false - description: >- - (Optional) Whether to quantize the base model weights + description: (Optional) Whether to quantize the base model weights additionalProperties: false required: - - type - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha + - type + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha title: LoraFinetuningConfig - description: >- - Configuration for Low-Rank Adaptation (LoRA) fine-tuning. + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: type: object properties: @@ -11785,19 +10712,17 @@ components: description: Algorithm type identifier, always "QAT" quantizer_name: type: string - description: >- - Name of the quantization algorithm to use + description: Name of the quantization algorithm to use group_size: type: integer description: Size of groups for grouped quantization additionalProperties: false required: - - type - - quantizer_name - - group_size + - type + - quantizer_name + - group_size title: QATFinetuningConfig - description: >- - Configuration for Quantization-Aware Training (QAT) fine-tuning. + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. SupervisedFineTuneRequest: type: object properties: @@ -11811,23 +10736,23 @@ components: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The hyperparam search configuration. logger_config: type: object additionalProperties: oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object + - type: 'null' + - type: boolean + - type: number + - type: string + - type: array + - type: object description: The logger configuration. model: type: string @@ -11840,10 +10765,10 @@ components: description: The algorithm configuration. additionalProperties: false required: - - job_uuid - - training_config - - hyperparam_search_config - - logger_config + - job_uuid + - training_config + - hyperparam_search_config + - logger_config title: SupervisedFineTuneRequest responses: BadRequest400: @@ -11857,8 +10782,7 @@ components: 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 + description: The client has sent too many requests in a given amount of time content: application/json: schema: @@ -11866,11 +10790,9 @@ components: example: status: 429 title: Too Many Requests - detail: >- - You have exceeded the rate limit. Please try again later. + detail: You have exceeded the rate limit. Please try again later. InternalServerError500: - description: >- - The server encountered an unexpected error + description: The server encountered an unexpected error content: application/json: schema: @@ -11878,8 +10800,7 @@ components: example: status: 500 title: Internal Server Error - detail: >- - An unexpected error occurred. Our team has been notified. + detail: An unexpected error occurred. Our team has been notified. DefaultError: description: An unexpected error occurred content: @@ -11891,114 +10812,102 @@ components: title: Error detail: An unexpected error occurred security: - - Default: [] +- Default: [] tags: - - name: Agents - description: >- - APIs for creating and interacting with agentic systems. - x-displayName: Agents - - name: Batches - description: >- - The API is designed to allow use of openai client libraries for seamless integration. +- name: Agents + description: APIs for creating and interacting with agentic systems. + x-displayName: Agents +- name: Batches + description: "The API is designed to allow use of openai client libraries for seamless\ + \ integration.\n\nThis API provides the following extensions:\n - idempotent batch\ + \ creation\n\nNote: This API is currently under active development and may undergo\ + \ changes." + 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. +- name: Benchmarks + description: '' +- name: Conversations + description: Protocol for conversation management operations. + x-displayName: Conversations +- name: DatasetIO + description: '' +- name: Datasets + description: '' +- name: Eval + description: Llama Stack Evaluation API for running evaluations on model and agent + candidates. + x-displayName: Evaluations +- name: Files + description: This API is used to upload documents that can be used with other Llama + Stack APIs. + x-displayName: Files +- name: Inference + description: 'Llama Stack Inference API for generating completions, chat completions, + and embeddings. - This API provides the following extensions: - - idempotent batch creation + This API provides the raw interface to the underlying models. Three kinds of models + are supported: - Note: This API is currently under active development and may undergo changes. - 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. - - name: Benchmarks - description: '' - - name: Conversations - description: >- - Protocol for conversation management operations. - x-displayName: Conversations - - name: DatasetIO - description: '' - - name: Datasets - description: '' - - name: Eval - description: >- - Llama Stack Evaluation API for running evaluations on model and agent candidates. - x-displayName: Evaluations - - name: Files - description: >- - This API is used to upload documents that can be used with other Llama Stack - APIs. - x-displayName: Files - - name: Inference - description: >- - Llama Stack Inference API for generating completions, chat completions, and - embeddings. + - LLM models: these models generate "raw" and "chat" (conversational) completions. + - Embedding models: these models generate embeddings to be used for semantic search. - 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. - x-displayName: Inference - - name: Inspect - description: >- - APIs for inspecting the Llama Stack service, including health status, available - API routes with methods and implementing providers. - x-displayName: Inspect - - name: Models - description: '' - - name: PostTraining (Coming Soon) - description: '' - - name: Prompts - description: >- - Protocol for prompt management operations. - x-displayName: Prompts - - name: Providers - description: >- - Providers API for inspecting, listing, and modifying providers and their configurations. - x-displayName: Providers - - name: Safety - description: OpenAI-compatible Moderations API. - x-displayName: Safety - - name: Scoring - description: '' - - name: ScoringFunctions - description: '' - - name: Shields - description: '' - - name: ToolGroups - description: '' - - name: ToolRuntime - description: '' - - name: VectorIO - description: '' + - Rerank models: these models reorder the documents based on their relevance to + a query.' + x-displayName: Inference +- name: Inspect + description: APIs for inspecting the Llama Stack service, including health status, + available API routes with methods and implementing providers. + x-displayName: Inspect +- name: Models + description: '' +- name: PostTraining (Coming Soon) + description: '' +- name: Prompts + description: Protocol for prompt management operations. + x-displayName: Prompts +- name: Providers + description: Providers API for inspecting, listing, and modifying providers and + their configurations. + x-displayName: Providers +- name: Safety + description: OpenAI-compatible Moderations API. + x-displayName: Safety +- name: Scoring + description: '' +- name: ScoringFunctions + description: '' +- name: Shields + description: '' +- name: ToolGroups + description: '' +- name: ToolRuntime + description: '' +- name: VectorIO + description: '' 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 +- 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 diff --git a/src/llama_stack/apis/vector_io/vector_io.py b/src/llama_stack/apis/vector_io/vector_io.py index 26c961db3..846c6f191 100644 --- a/src/llama_stack/apis/vector_io/vector_io.py +++ b/src/llama_stack/apis/vector_io/vector_io.py @@ -396,19 +396,19 @@ class VectorStoreListFilesResponse(BaseModel): @json_schema_type -class VectorStoreFileContentsResponse(BaseModel): - """Response from retrieving the contents of a vector store file. +class VectorStoreFileContentResponse(BaseModel): + """Represents the parsed content of a vector store file. - :param file_id: Unique identifier for the file - :param filename: Name of the file - :param attributes: Key-value attributes associated with the file - :param content: List of content items from the file + :param object: The object type, which is always `vector_store.file_content.page` + :param data: Parsed content of the file + :param has_more: Indicates if there are more content pages to fetch + :param next_page: The token for the next page, if any """ - file_id: str - filename: str - attributes: dict[str, Any] - content: list[VectorStoreContent] + object: Literal["vector_store.file_content.page"] = "vector_store.file_content.page" + data: list[VectorStoreContent] + has_more: bool + next_page: str | None = None @json_schema_type @@ -732,12 +732,12 @@ class VectorIO(Protocol): self, vector_store_id: str, file_id: str, - ) -> VectorStoreFileContentsResponse: + ) -> VectorStoreFileContentResponse: """Retrieves the contents of a vector store file. :param vector_store_id: The ID of the vector store containing the file to retrieve. :param file_id: The ID of the file to retrieve. - :returns: A list of InterleavedContent representing the file contents. + :returns: A VectorStoreFileContentResponse representing the file contents. """ ... diff --git a/src/llama_stack/core/routers/vector_io.py b/src/llama_stack/core/routers/vector_io.py index b54217619..9dac461db 100644 --- a/src/llama_stack/core/routers/vector_io.py +++ b/src/llama_stack/core/routers/vector_io.py @@ -24,7 +24,7 @@ from llama_stack.apis.vector_io import ( VectorStoreChunkingStrategyStaticConfig, VectorStoreDeleteResponse, VectorStoreFileBatchObject, - VectorStoreFileContentsResponse, + VectorStoreFileContentResponse, VectorStoreFileDeleteResponse, VectorStoreFileObject, VectorStoreFilesListInBatchResponse, @@ -338,7 +338,7 @@ class VectorIORouter(VectorIO): self, vector_store_id: str, file_id: str, - ) -> VectorStoreFileContentsResponse: + ) -> VectorStoreFileContentResponse: logger.debug(f"VectorIORouter.openai_retrieve_vector_store_file_contents: {vector_store_id}, {file_id}") provider = await self.routing_table.get_provider_impl(vector_store_id) return await provider.openai_retrieve_vector_store_file_contents( diff --git a/src/llama_stack/core/routing_tables/vector_stores.py b/src/llama_stack/core/routing_tables/vector_stores.py index c6c80a01e..f95a4dbe3 100644 --- a/src/llama_stack/core/routing_tables/vector_stores.py +++ b/src/llama_stack/core/routing_tables/vector_stores.py @@ -15,7 +15,7 @@ from llama_stack.apis.vector_io.vector_io import ( SearchRankingOptions, VectorStoreChunkingStrategy, VectorStoreDeleteResponse, - VectorStoreFileContentsResponse, + VectorStoreFileContentResponse, VectorStoreFileDeleteResponse, VectorStoreFileObject, VectorStoreFileStatus, @@ -195,7 +195,7 @@ class VectorStoresRoutingTable(CommonRoutingTableImpl): self, vector_store_id: str, file_id: str, - ) -> VectorStoreFileContentsResponse: + ) -> VectorStoreFileContentResponse: await self.assert_action_allowed("read", "vector_store", vector_store_id) provider = await self.get_provider_impl(vector_store_id) return await provider.openai_retrieve_vector_store_file_contents( diff --git a/src/llama_stack/providers/utils/memory/openai_vector_store_mixin.py b/src/llama_stack/providers/utils/memory/openai_vector_store_mixin.py index d047d9d12..86e6ea013 100644 --- a/src/llama_stack/providers/utils/memory/openai_vector_store_mixin.py +++ b/src/llama_stack/providers/utils/memory/openai_vector_store_mixin.py @@ -30,7 +30,7 @@ from llama_stack.apis.vector_io import ( VectorStoreContent, VectorStoreDeleteResponse, VectorStoreFileBatchObject, - VectorStoreFileContentsResponse, + VectorStoreFileContentResponse, VectorStoreFileCounts, VectorStoreFileDeleteResponse, VectorStoreFileLastError, @@ -921,22 +921,21 @@ class OpenAIVectorStoreMixin(ABC): self, vector_store_id: str, file_id: str, - ) -> VectorStoreFileContentsResponse: + ) -> VectorStoreFileContentResponse: """Retrieves the contents of a vector store file.""" if vector_store_id not in self.openai_vector_stores: raise VectorStoreNotFoundError(vector_store_id) - file_info = await self._load_openai_vector_store_file(vector_store_id, file_id) dict_chunks = await self._load_openai_vector_store_file_contents(vector_store_id, file_id) chunks = [Chunk.model_validate(c) for c in dict_chunks] content = [] for chunk in chunks: content.extend(self._chunk_to_vector_store_content(chunk)) - return VectorStoreFileContentsResponse( - file_id=file_id, - filename=file_info.get("filename", ""), - attributes=file_info.get("attributes", {}), - content=content, + return VectorStoreFileContentResponse( + object="vector_store.file_content.page", + data=content, + has_more=False, + next_page=None, ) async def openai_update_vector_store_file( diff --git a/tests/integration/vector_io/test_openai_vector_stores.py b/tests/integration/vector_io/test_openai_vector_stores.py index 97ce4abe8..20f9d2978 100644 --- a/tests/integration/vector_io/test_openai_vector_stores.py +++ b/tests/integration/vector_io/test_openai_vector_stores.py @@ -907,16 +907,16 @@ def test_openai_vector_store_retrieve_file_contents( ) assert file_contents is not None - assert len(file_contents.content) == 1 - content = file_contents.content[0] + assert file_contents.object == "vector_store.file_content.page" + assert len(file_contents.data) == 1 + content = file_contents.data[0] # llama-stack-client returns a model, openai-python is a badboy and returns a dict if not isinstance(content, dict): content = content.model_dump() assert content["type"] == "text" assert content["text"] == test_content.decode("utf-8") - assert file_contents.filename == file_name - assert file_contents.attributes == attributes + assert file_contents.has_more is False @vector_provider_wrapper @@ -1483,14 +1483,12 @@ def test_openai_vector_store_file_batch_retrieve_contents( ) assert file_contents is not None - assert file_contents.filename == file_data[i][0] - assert len(file_contents.content) > 0 + assert file_contents.object == "vector_store.file_content.page" + assert len(file_contents.data) > 0 # Verify the content matches what we uploaded content_text = ( - file_contents.content[0].text - if hasattr(file_contents.content[0], "text") - else file_contents.content[0]["text"] + file_contents.data[0].text if hasattr(file_contents.data[0], "text") else file_contents.data[0]["text"] ) assert file_data[i][1].decode("utf-8") in content_text