diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2b32524ba..c31a39406 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -114,7 +114,7 @@ repos: language: python pass_filenames: false require_serial: true - files: ^src/llama_stack/apis/ + files: ^src/llama_stack_api/.*$ - id: check-workflows-use-hashes name: Check GitHub Actions use SHA-pinned actions entry: ./scripts/check-workflows-use-hashes.sh diff --git a/client-sdks/stainless/openapi.yml b/client-sdks/stainless/openapi.yml index a3e1f39fd..cc0533382 100644 --- a/client-sdks/stainless/openapi.yml +++ b/client-sdks/stainless/openapi.yml @@ -14,1412 +14,18 @@ info: servers: - url: http://any-hosted-llama-stack.com paths: - /v1/batches: - get: - responses: - '200': - description: A list of batch objects. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBatchesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - post: - responses: - '200': - description: The created batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $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. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBatchRequest' - required: true - deprecated: false - /v1/batches/{batch_id}: - get: - responses: - '200': - description: The batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $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. - parameters: - - 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: - responses: - '200': - description: The updated batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - /v1/chat/completions: - get: - responses: - '200': - description: A ListOpenAIChatCompletionResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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' - deprecated: false - post: - responses: - '200': - description: An OpenAIChatCompletion. - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletion' - - $ref: '#/components/schemas/OpenAIChatCompletionChunk' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Create chat completions. - description: >- - Create chat completions. - - Generate an OpenAI-compatible chat completion for the given messages using - the specified model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' - required: true - deprecated: false - /v1/chat/completions/{completion_id}: - get: - responses: - '200': - description: A OpenAICompletionWithInputMessages. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Get chat completion. - description: >- - Get chat completion. - - Describe a chat completion by its ID. - parameters: - - name: completion_id - in: path - description: ID of the chat completion. - required: true - schema: - type: string - deprecated: false - /v1/completions: - post: - responses: - '200': - description: An OpenAICompletion. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletion' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Create completion. - description: >- - Create completion. - - Generate an OpenAI-compatible completion for the given prompt using the specified - model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' - required: true - deprecated: false - /v1/conversations: - post: - responses: - '200': - description: The created conversation object. - content: - application/json: - schema: - $ref: '#/components/schemas/Conversation' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Create a conversation. - description: >- - Create a conversation. - - Create a conversation. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateConversationRequest' - required: true - deprecated: false - /v1/conversations/{conversation_id}: - get: - responses: - '200': - description: The conversation object. - content: - application/json: - schema: - $ref: '#/components/schemas/Conversation' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Retrieve a conversation. - description: >- - Retrieve a conversation. - - Get a conversation with the given ID. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - deprecated: false - post: - responses: - '200': - description: The updated conversation object. - content: - application/json: - schema: - $ref: '#/components/schemas/Conversation' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Update a conversation. - description: >- - Update a conversation. - - Update a conversation's metadata with the given ID. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConversationRequest' - required: true - deprecated: false - delete: - responses: - '200': - description: The deleted conversation resource. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationDeletedResource' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Delete a conversation. - description: >- - Delete a conversation. - - Delete a conversation with the given ID. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - deprecated: false - /v1/conversations/{conversation_id}/items: - get: - responses: - '200': - description: List of conversation items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: List items. - description: >- - List items. - - 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: - type: string - enum: - - asc - - desc - deprecated: false - post: - responses: - '200': - description: List of created items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Create items. - description: >- - Create items. - - Create items in the conversation. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddItemsRequest' - required: true - deprecated: false - /v1/conversations/{conversation_id}/items/{item_id}: - get: - responses: - '200': - description: The conversation item. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItem' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Retrieve an item. - description: >- - Retrieve an 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 - deprecated: false - delete: - responses: - '200': - description: The deleted item resource. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemDeletedResource' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Delete an item. - description: >- - Delete an 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 - deprecated: false - /v1/embeddings: - post: - responses: - '200': - description: >- - An OpenAIEmbeddingsResponse containing the embeddings. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Create embeddings. - description: >- - Create embeddings. - - Generate OpenAI-compatible embeddings for the given input using the specified - model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' - required: true - deprecated: false - /v1/files: - get: - responses: - '200': - description: >- - An ListOpenAIFileResponse containing the list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIFileResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: List files. - description: >- - List files. - - 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' - deprecated: false - post: - responses: - '200': - description: >- - An OpenAIFileObject representing the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: Upload file. - description: >- - Upload file. - - Upload a file that can be used across various endpoints. - - - The file upload should be a multipart form request with: - - - file: The File object (not file name) to be uploaded. - - - purpose: The intended purpose of the uploaded file. - - - expires_after: Optional form values describing expiration for the file. - parameters: [] - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - expires_after: - $ref: '#/components/schemas/ExpiresAfter' - required: - - file - - purpose - required: true - deprecated: false - /v1/files/{file_id}: - get: - responses: - '200': - description: >- - An OpenAIFileObject containing file information. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: Retrieve file. - description: >- - Retrieve 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 - deprecated: false - delete: - responses: - '200': - description: >- - An OpenAIFileDeleteResponse indicating successful deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFileDeleteResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - /v1/files/{file_id}/content: - get: - responses: - '200': - description: >- - The raw file content as a binary response. - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: Retrieve file content. - description: >- - Retrieve file content. - - 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 - deprecated: false - /v1/health: - get: - responses: - '200': - description: >- - Health information indicating if the service is operational. - content: - application/json: - schema: - $ref: '#/components/schemas/HealthInfo' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inspect - summary: Get health status. - description: >- - Get health status. - - 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. - content: - application/json: - schema: - $ref: '#/components/schemas/ListRoutesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inspect - summary: List routes. - description: >- - List routes. - - 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 all non-deprecated routes. - required: false - schema: - type: string - enum: - - v1 - - v1alpha - - v1beta - - deprecated - deprecated: false - /v1/models: - get: - responses: - '200': - description: A OpenAIListModelsResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIListModelsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: List models using the OpenAI API. - description: List models using the OpenAI API. - parameters: [] - deprecated: false - post: - responses: - '200': - description: A Model. - content: - application/json: - schema: - $ref: '#/components/schemas/Model' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: Register model. - description: >- - Register model. - - Register a model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterModelRequest' - required: true - deprecated: true - /v1/models/{model_id}: - get: - responses: - '200': - description: A Model. - content: - application/json: - schema: - $ref: '#/components/schemas/Model' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: Get model. - description: >- - Get model. - - 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 - deprecated: false - delete: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: Unregister model. - description: >- - Unregister model. - - Unregister a model. - parameters: - - name: model_id - in: path - description: >- - The identifier of the model to unregister. - required: true - schema: - type: string - deprecated: true - /v1/moderations: - post: - responses: - '200': - description: A moderation object. - content: - application/json: - schema: - $ref: '#/components/schemas/ModerationObject' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Safety - summary: Create moderation. - description: >- - Create moderation. - - Classifies if text and/or image inputs are potentially harmful. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RunModerationRequest' - required: true - deprecated: false - /v1/prompts: - get: - responses: - '200': - description: >- - A ListPromptsResponse containing all prompts. - content: - application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: List all prompts. - description: List all prompts. - parameters: [] - deprecated: false - post: - responses: - '200': - description: The created Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Create prompt. - description: >- - Create prompt. - - Create a new prompt. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePromptRequest' - required: true - deprecated: false - /v1/prompts/{prompt_id}: - get: - responses: - '200': - description: A Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Get prompt. - description: >- - Get prompt. - - 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 - deprecated: false - post: - responses: - '200': - description: >- - The updated Prompt resource with incremented version. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Update prompt. - description: >- - Update prompt. - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdatePromptRequest' - required: true - deprecated: false - delete: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Delete prompt. - description: >- - Delete prompt. - - Delete a prompt. - parameters: - - 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. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Set prompt version. - description: >- - Set prompt version. - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetDefaultVersionRequest' - required: true - deprecated: false - /v1/prompts/{prompt_id}/versions: - get: - responses: - '200': - description: >- - A ListPromptsResponse containing all versions of the prompt. - content: - application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: List prompt versions. - description: >- - List prompt versions. - - 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 - deprecated: false - /v1/providers: - get: - responses: - '200': - description: >- - A ListProvidersResponse containing information about all providers. - content: - application/json: - schema: - $ref: '#/components/schemas/ListProvidersResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Providers - summary: List providers. - description: >- - List providers. - - List all available providers. - parameters: [] - deprecated: false /v1/providers/{provider_id}: get: tags: - Providers summary: Inspect Provider - description: |- - Get provider. - - Get detailed information about a specific provider. operationId: inspect_provider_v1_providers__provider_id__get responses: '200': - description: A ProviderInfo object containing the provider's details. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ProviderInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1444,18 +50,13 @@ paths: tags: - Providers summary: List Providers - description: |- - List providers. - - List all available providers. operationId: list_providers_v1_providers_get responses: '200': - description: A ListProvidersResponse containing information about all providers. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListProvidersResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1473,134 +74,60 @@ paths: tags: - Agents summary: List Openai Responses - description: List all responses. operationId: list_openai_responses_v1_responses_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 50 - title: Limit - - name: model - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Model - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order responses: '200': - description: A ListOpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIResponseObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Agents summary: Create Openai Response - description: Create a model response. operationId: create_openai_response_v1_responses_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_responses_Request' - x-llama-stack-extra-body-params: - guardrails: - $defs: - ResponseGuardrailSpec: - description: |- - Specification for a guardrail to apply during response generation. - - :param type: The type/identifier of the guardrail. - properties: - type: - title: Type - type: string - required: - - type - title: ResponseGuardrailSpec - type: object - anyOf: - - items: - anyOf: - - type: string - - $ref: '#/components/schemas/ResponseGuardrailSpec' - type: array - - type: 'null' - description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation. responses: '200': - description: An OpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseObject' - text/event-stream: - schema: - $ref: '#/components/schemas/OpenAIResponseObjectStream' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/responses/{response_id}: get: tags: - Agents summary: Get Openai Response - description: Get a model response. operationId: get_openai_response_v1_responses__response_id__get responses: '200': - description: An OpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1624,15 +151,13 @@ paths: tags: - Agents summary: Delete Openai Response - description: Delete a response. operationId: delete_openai_response_v1_responses__response_id__delete responses: '200': - description: An OpenAIDeleteResponseObject + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIDeleteResponseObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1657,95 +182,44 @@ paths: tags: - Agents summary: List Openai Response Input Items - description: List input items. operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' - - name: include - in: query - required: false - schema: - anyOf: - - type: array - items: - type: string - - type: 'null' - title: Include - responses: - '200': - description: An ListOpenAIResponseInputItem. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIResponseInputItem' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/chat/completions/{completion_id}: get: tags: - Inference summary: Get Chat Completion - description: |- - Get chat completion. - - Describe a chat completion by its ID. operationId: get_chat_completion_v1_chat_completions__completion_id__get responses: '200': - description: A OpenAICompletionWithInputMessages. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1770,180 +244,60 @@ paths: tags: - Inference summary: List Chat Completions - description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: model - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Model - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order responses: '200': - description: A ListOpenAIChatCompletionResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response - post: - tags: - - ScoringFunctions - summary: List all scoring functions. - description: List all scoring functions. - parameters: [] - deprecated: false - post: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: $ref: '#/components/responses/DefaultError' + post: tags: - - ScoringFunctions - summary: Register a scoring function. - description: Register a scoring function. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterScoringFunctionRequest' - required: true - deprecated: true - /v1/scoring-functions/{scoring_fn_id}: - get: + - Inference + summary: Openai Chat Completion + operationId: openai_chat_completion_v1_chat_completions_post responses: '200': - description: An OpenAIChatCompletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIChatCompletion' - text/event-stream: - schema: - $ref: '#/components/schemas/OpenAIChatCompletionChunk' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - delete: - responses: - '200': - description: OK - '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: + description: Default Response $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: true - /v1/scoring/score: + /v1/completions: post: tags: - Inference summary: Openai Completion - description: |- - Create completion. - - Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' - required: true responses: '200': - description: An OpenAICompletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAICompletion' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1961,24 +315,13 @@ paths: tags: - Inference summary: Openai Embeddings - description: |- - Create embeddings. - - Generate OpenAI-compatible embeddings for the given input using the specified model. operationId: openai_embeddings_v1_embeddings_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' - required: true responses: '200': - description: An OpenAIEmbeddingsResponse containing the embeddings. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1994,50 +337,15 @@ paths: /v1alpha/inference/rerank: post: tags: - - Shields - summary: List all shields. - description: List all shields. - parameters: [] - deprecated: false - post: + - Inference + summary: Rerank + operationId: rerank_v1alpha_inference_rerank_post responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Shields - summary: Register a shield. - description: Register a shield. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterShieldRequest' - required: true - deprecated: true - /v1/shields/{identifier}: - get: - responses: - '200': - description: RerankResponse with indices sorted by relevance score (descending). - content: - application/json: - schema: - $ref: '#/components/schemas/RerankResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2055,18 +363,13 @@ paths: tags: - Inspect summary: Health - description: |- - Get health status. - - Get the current health status of the service. operationId: health_v1_health_get responses: '200': - description: Health information indicating if the service is operational. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/HealthInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2084,65 +387,61 @@ paths: tags: - Inspect summary: List Routes - description: |- - List routes. - - List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get - parameters: - - name: api_filter - in: query - required: false - schema: - anyOf: - - enum: - - v1 - - v1alpha - - v1beta - - deprecated - type: string - deprecated: false - delete: responses: '200': - description: OK + description: Successful Response + content: + application/json: + schema: {} '400': + description: Bad Request $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: + description: Default Response $ref: '#/components/responses/DefaultError' + /v1/version: + get: tags: - - 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 - deprecated: true - /v1/tool-runtime/invoke: + - Inspect + summary: Version + operationId: version_v1_version_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' + /v1/batches/{batch_id}/cancel: post: tags: - Batches summary: Cancel Batch - description: Cancel a batch that is in progress. operationId: cancel_batch_v1_batches__batch_id__cancel_post responses: '200': - description: The updated batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2163,196 +462,64 @@ paths: type: string description: 'Path parameter: batch_id' /v1/batches: - post: - tags: - - Batches - summary: Create Batch - description: Create a new batch for processing multiple API requests. - operationId: create_batch_v1_batches_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_batches_Request' - responses: - '200': - description: The created batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - tags: - - ToolGroups - summary: List tool groups with optional provider. - description: List tool groups with optional provider. - parameters: [] - deprecated: false - post: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - ToolGroups - summary: Register a tool group. - description: Register a tool group. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterToolGroupRequest' - required: true - deprecated: true - /v1/toolgroups/{toolgroup_id}: get: tags: - Batches summary: List Batches - description: List all batches for the current user. operationId: list_batches_v1_batches_get - parameters: - - name: toolgroup_id - in: path - description: The ID of the tool group to get. - required: true - schema: - type: string - deprecated: false - delete: responses: '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: true - /v1/tools: - get: - tags: - - Batches - summary: List Batches - description: List all batches for the current user. - operationId: list_batches_v1_batches_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - type: integer - default: 20 - title: Limit - responses: - '200': - description: A list of batch objects. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListBatchesResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Batches summary: Create Batch - description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_batches_Request' responses: '200': - description: The created batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/batches/{batch_id}: get: tags: - Batches summary: Retrieve Batch - description: Retrieve information about a specific batch. operationId: retrieve_batch_v1_batches__batch_id__get responses: '200': - description: The batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2377,17 +544,7 @@ paths: tags: - Vector Io summary: Insert Chunks - description: Insert chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Chunk-Input' - title: Chunks responses: '200': description: Successful Response @@ -2395,128 +552,71 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/files: get: tags: - Vector Io summary: Openai List Files In Vector Store - description: List files in a vector store. operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: filter - in: query - required: false - schema: - title: Filter - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - nullable: true - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - responses: - '200': - description: A VectorStoreListFilesResponse containing the list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreListFilesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Vector Io summary: Openai Attach File To Vector Store - description: Attach a file to a vector store. operationId: openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_files_Request' responses: '200': - description: A VectorStoreFileObject representing the attached file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path @@ -2529,15 +629,13 @@ paths: tags: - Vector Io summary: Openai Cancel Vector Store File Batch - description: Cancels a vector store file batch. operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post responses: '200': - description: A VectorStoreFileBatchObject representing the cancelled file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2568,119 +666,60 @@ paths: tags: - Vector Io summary: Openai List Vector Stores - description: Returns a list of vector stores. operationId: openai_list_vector_stores_v1_vector_stores_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order responses: '200': - description: A VectorStoreListResponse containing the list of vector stores. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreListResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Vector Io summary: Openai Create Vector Store - description: |- - Creates a vector store. - - Generate an OpenAI-compatible vector store with the given parameters. operationId: openai_create_vector_store_v1_vector_stores_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' responses: '200': - description: A VectorStoreObject representing the created vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/file_batches: post: tags: - Vector Io summary: Openai Create Vector Store File Batch - description: |- - Create a vector store file batch. - - Generate an OpenAI-compatible vector store file batch for the given vector store. operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' - required: true responses: '200': - description: A VectorStoreFileBatchObject representing the created file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2705,15 +744,13 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store - description: Retrieves a vector store. operationId: openai_retrieve_vector_store_v1_vector_stores__vector_store_id__get responses: '200': - description: A VectorStoreObject representing the vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2737,21 +774,13 @@ paths: tags: - Vector Io summary: Openai Update Vector Store - description: Updates a vector store. operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_Request' - required: true responses: '200': - description: A VectorStoreObject representing the updated vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2775,15 +804,13 @@ paths: tags: - Vector Io summary: Openai Delete Vector Store - description: Delete a vector store. operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete responses: '200': - description: A VectorStoreDeleteResponse indicating the deletion status. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2808,15 +835,13 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store File - description: Retrieves a vector store file. operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get responses: '200': - description: A VectorStoreFileObject representing the file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2846,21 +871,13 @@ paths: tags: - Vector Io summary: Openai Update Vector Store File - description: Updates a vector store file. operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_files_file_id_Request' - required: true responses: '200': - description: A VectorStoreFileObject representing the updated file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2890,15 +907,13 @@ paths: tags: - Vector Io summary: Openai Delete Vector Store File - description: Delete a vector store file. operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete responses: '200': - description: A VectorStoreFileDeleteResponse indicating the deletion status. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2929,51 +944,26 @@ paths: tags: - Vector Io summary: Openai List Files In Vector Store File Batch - description: Returns a list of vector store files in a batch. operationId: openai_list_files_in_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: filter - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Filter - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order - name: vector_store_id in: path required: true @@ -2986,39 +976,18 @@ paths: schema: type: string description: 'Path parameter: batch_id' - responses: - '200': - description: A VectorStoreFilesListInBatchResponse containing the list of files in the batch. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}: get: tags: - Vector Io summary: Openai Retrieve Vector Store File Batch - description: Retrieve a vector store file batch. operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get responses: '200': - description: A VectorStoreFileBatchObject representing the file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3049,27 +1018,26 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store File Contents - description: Retrieves the contents of a vector store file. operationId: openai_retrieve_vector_store_file_contents_v1_vector_stores__vector_store_id__files__file_id__content_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: include_embeddings - in: query - required: false - schema: - anyOf: - - type: boolean - - type: 'null' - default: false - title: Include Embeddings - - name: include_metadata - in: query - required: false - schema: - anyOf: - - type: boolean - - type: 'null' - default: false - title: Include Metadata - name: vector_store_id in: path required: true @@ -3082,48 +1050,18 @@ paths: schema: type: string description: 'Path parameter: file_id' - responses: - '200': - description: File contents, optionally with embeddings and metadata based on query parameters. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileContentResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/vector_stores/{vector_store_id}/search: post: tags: - Vector Io summary: Openai Search Vector Store - description: |- - Search for chunks in a vector store. - - Searches a vector store for relevant chunks based on a query and optional file attribute filters. operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_search_Request' - required: true responses: '200': - description: A VectorStoreSearchResponse containing the search results. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreSearchResponsePage' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3148,21 +1086,13 @@ paths: tags: - Vector Io summary: Query Chunks - description: Query chunks from a vector database. operationId: query_chunks_v1_vector_io_query_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_io_query_Request' - required: true responses: '200': - description: A QueryChunksResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/QueryChunksResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3180,18 +1110,13 @@ paths: tags: - Models summary: Get Model - description: |- - Get model. - - Get a model by its identifier. operationId: get_model_v1_models__model_id__get responses: '200': - description: A Model. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Model' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3216,15 +1141,13 @@ paths: tags: - Models summary: Openai List Models - description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get responses: '200': - description: A OpenAIListModelsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIListModelsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3242,24 +1165,13 @@ paths: tags: - Safety summary: Run Moderation - description: |- - Create moderation. - - Classifies if text and/or image inputs are potentially harmful. operationId: run_moderation_v1_moderations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_moderations_Request' - required: true responses: '200': - description: A moderation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ModerationObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3277,24 +1189,13 @@ paths: tags: - Safety summary: Run Shield - description: |- - Run shield. - - Run a shield. operationId: run_shield_v1_safety_run_shield_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_safety_run_shield_Request' - required: true responses: '200': - description: A RunShieldResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/RunShieldResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3312,15 +1213,13 @@ paths: tags: - Shields summary: Get Shield - description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3345,15 +1244,13 @@ paths: tags: - Shields summary: List Shields - description: List all shields. operationId: list_shields_v1_shields_get responses: '200': - description: A ListShieldsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListShieldsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3371,18 +1268,7 @@ paths: tags: - Datasetio summary: Append Rows - description: Append rows to a dataset. operationId: append_rows_v1beta_datasetio_append_rows__dataset_id__post - requestBody: - content: - application/json: - schema: - items: - additionalProperties: true - type: object - type: array - title: Rows - required: true responses: '200': description: Successful Response @@ -3413,73 +1299,44 @@ paths: tags: - Datasetio summary: Iterrows - description: |- - Get a paginated list of rows from a dataset. - - Uses offset-based pagination where: - - start_index: The starting index (0-based). If None, starts from beginning. - - limit: Number of items to return. If None or -1, returns all items. - - The response includes: - - data: List of items for the current page. - - has_more: Whether there are more items available after this set. operationId: iterrows_v1beta_datasetio_iterrows__dataset_id__get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Limit - - name: start_index - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Start Index - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' - responses: - '200': - description: A PaginatedResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1beta/datasets/{dataset_id}: get: tags: - Datasets summary: Get Dataset - description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get responses: '200': - description: A Dataset. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Dataset' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3504,15 +1361,13 @@ paths: tags: - Datasets summary: List Datasets - description: List all datasets. operationId: list_datasets_v1beta_datasets_get responses: '200': - description: A ListDatasetsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListDatasetsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3530,21 +1385,13 @@ paths: tags: - Scoring summary: Score - description: Score a list of rows. operationId: score_v1_scoring_score_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_scoring_score_Request' - required: true responses: '200': - description: A ScoreResponse object containing rows and aggregated results. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoreResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3562,21 +1409,13 @@ paths: tags: - Scoring summary: Score Batch - description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_scoring_score_batch_Request' - required: true responses: '200': - description: A ScoreBatchResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoreBatchResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3594,15 +1433,13 @@ paths: tags: - Scoring Functions summary: Get Scoring Function - description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get responses: '200': - description: A ScoringFn. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoringFn' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3627,47 +1464,37 @@ paths: tags: - Scoring Functions summary: List Scoring Functions - description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get responses: '200': - description: A ListScoringFunctionsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListScoringFunctionsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: post: tags: - Eval summary: Evaluate Rows - description: Evaluate a list of rows on a benchmark. operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_eval_benchmarks_benchmark_id_evaluations_Request' - required: true responses: '200': - description: EvaluateResponse object containing generations and scores. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/EvaluateResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3692,15 +1519,13 @@ paths: tags: - Eval summary: Job Status - description: Get the status of a job. operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get responses: '200': - description: The status of the evaluation job. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Job' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3730,7 +1555,6 @@ paths: tags: - Eval summary: Job Cancel - description: Cancel a job. operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete responses: '200': @@ -3768,15 +1592,13 @@ paths: tags: - Eval summary: Job Result - description: Get the result of a job. operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get responses: '200': - description: The result of the job. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/EvaluateResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3807,21 +1629,13 @@ paths: tags: - Eval summary: Run Eval - description: Run an evaluation on a benchmark. operationId: run_eval_v1alpha_eval_benchmarks__benchmark_id__jobs_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BenchmarkConfig' - required: true responses: '200': - description: The job that was created to run the evaluation. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Job' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3846,15 +1660,13 @@ paths: tags: - Benchmarks summary: Get Benchmark - description: Get a benchmark by its ID. operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get responses: '200': - description: A Benchmark. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Benchmark' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3879,41 +1691,7 @@ paths: tags: - Benchmarks summary: List Benchmarks - description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get - responses: - '200': - description: A ListBenchmarksResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBenchmarksResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response - /v1alpha/post-training/job/cancel: - post: - tags: - - Post Training - summary: Cancel Training Job - description: Cancel a training job. - operationId: cancel_training_job_v1alpha_post_training_job_cancel_post - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': description: Successful Response @@ -3921,97 +1699,101 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' + /v1alpha/post-training/job/cancel: + post: + tags: + - Post Training + summary: Cancel Training Job + operationId: cancel_training_job_v1alpha_post_training_job_cancel_post + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/artifacts: get: tags: - Post Training summary: Get Training Job Artifacts - description: Get the artifacts of a training job. operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': - description: A PostTrainingJobArtifactsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/status: get: tags: - Post Training summary: Get Training Job Status - description: Get the status of a training job. operationId: get_training_job_status_v1alpha_post_training_job_status_get - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': - description: A PostTrainingJobStatusResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJobStatusResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/jobs: get: tags: - Post Training summary: Get Training Jobs - description: Get all training jobs. operationId: get_training_jobs_v1alpha_post_training_jobs_get responses: '200': - description: A ListPostTrainingJobsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPostTrainingJobsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4029,21 +1811,13 @@ paths: tags: - Post Training summary: Preference Optimize - description: Run preference optimization of a model. operationId: preference_optimize_v1alpha_post_training_preference_optimize_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_post_training_preference_optimize_Request' - required: true responses: '200': - description: A PostTrainingJob. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJob' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4061,21 +1835,13 @@ paths: tags: - Post Training summary: Supervised Fine Tune - description: Run supervised fine-tuning of a model. operationId: supervised_fine_tune_v1alpha_post_training_supervised_fine_tune_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_post_training_supervised_fine_tune_Request' - required: true responses: '200': - description: A PostTrainingJob. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJob' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4093,15 +1859,13 @@ paths: tags: - Tool Groups summary: Get Tool - description: Get a tool by its name. operationId: get_tool_v1_tools__tool_name__get responses: '200': - description: A ToolDef. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolDef' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4126,15 +1890,13 @@ paths: tags: - Tool Groups summary: Get Tool Group - description: Get a tool group by its ID. operationId: get_tool_group_v1_toolgroups__toolgroup_id__get responses: '200': - description: A ToolGroup. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolGroup' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4159,82 +1921,61 @@ paths: tags: - Tool Groups summary: List Tool Groups - description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get responses: '200': - description: A ListToolGroupsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolGroupsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tools: get: tags: - Tool Groups summary: List Tools - description: List tools with optional tool group. operationId: list_tools_v1_tools_get - parameters: - - name: toolgroup_id - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Toolgroup Id responses: '200': - description: A ListToolDefsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolDefsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tool-runtime/invoke: post: tags: - Tool Runtime summary: Invoke Tool - description: Run a tool with the given arguments. operationId: invoke_tool_v1_tool_runtime_invoke_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_tool_runtime_invoke_Request' - required: true responses: '200': - description: A ToolInvocationResult. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolInvocationResult' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4252,61 +1993,37 @@ paths: tags: - Tool Runtime summary: List Runtime Tools - description: List all tools in the runtime. operationId: list_runtime_tools_v1_tool_runtime_list_tools_get - parameters: - - name: tool_group_id - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Tool Group Id - - name: mcp_endpoint - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/URL' - - type: 'null' - title: Mcp Endpoint responses: '200': - description: A ListToolDefsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolDefsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/files/{file_id}: get: tags: - Files summary: Openai Retrieve File - description: |- - Retrieve file. - - Returns information about a specific file. operationId: openai_retrieve_file_v1_files__file_id__get responses: '200': - description: An OpenAIFileObject containing file information. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4330,15 +2047,13 @@ paths: tags: - Files summary: Openai Delete File - description: Delete file. operationId: openai_delete_file_v1_files__file_id__delete responses: '200': - description: An OpenAIFileDeleteResponse indicating successful deletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4363,117 +2078,57 @@ paths: tags: - Files summary: Openai List Files - description: |- - List files. - - Returns a list of files that belong to the user's organization. operationId: openai_list_files_v1_files_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 10000 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order - - name: purpose - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/OpenAIFilePurpose' - - type: 'null' - title: Purpose responses: '200': - description: An ListOpenAIFileResponse containing the list of files. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIFileResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Files summary: Openai Upload File - description: |- - Upload file. - - Upload a file that can be used across various endpoints. - - The file upload should be a multipart form request with: - - file: The File object (not file name) to be uploaded. - - purpose: The intended purpose of the uploaded file. - - expires_after: Optional form values describing expiration for the file. operationId: openai_upload_file_v1_files_post - requestBody: - required: true - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/Body_openai_upload_file_v1_files_post' responses: '200': - description: An OpenAIFileObject representing the uploaded file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/files/{file_id}/content: get: tags: - Files summary: Openai Retrieve File Content - description: |- - Retrieve file content. - - Returns the contents of the specified file. operationId: openai_retrieve_file_content_v1_files__file_id__content_get responses: '200': - description: The raw file content as a binary response. + description: Successful Response content: application/json: schema: {} @@ -4501,15 +2156,13 @@ paths: tags: - Prompts summary: List Prompts - description: List all prompts. operationId: list_prompts_v1_prompts_get responses: '200': - description: A ListPromptsResponse containing all prompts. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4526,24 +2179,13 @@ paths: tags: - Prompts summary: Create Prompt - description: |- - Create prompt. - - Create a new prompt. operationId: create_prompt_v1_prompts_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_Request' - required: true responses: '200': - description: The created Prompt resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4561,79 +2203,55 @@ paths: tags: - Prompts summary: Get Prompt - description: |- - Get prompt. - - Get a prompt by its identifier and optional version. operationId: get_prompt_v1_prompts__prompt_id__get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: version - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Version - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' - responses: - '200': - description: A Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Prompts summary: Update Prompt - description: |- - Update prompt. - - Update an existing prompt (increments version). operationId: update_prompt_v1_prompts__prompt_id__post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_prompt_id_Request' responses: '200': - description: The updated Prompt resource with incremented version. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path @@ -4645,10 +2263,6 @@ paths: tags: - Prompts summary: Delete Prompt - description: |- - Delete prompt. - - Delete a prompt. operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': @@ -4657,17 +2271,17 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path @@ -4680,18 +2294,13 @@ paths: tags: - Prompts summary: List Prompt Versions - description: |- - List prompt versions. - - List all versions of a specific prompt. operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get responses: '200': - description: A ListPromptsResponse containing all versions of the prompt. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4716,24 +2325,13 @@ paths: tags: - Prompts summary: Set Default Version - description: |- - Set prompt version. - - Set which version of a prompt should be the default in get_prompt (latest). operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_prompt_id_set_default_version_Request' - required: true responses: '200': - description: The prompt with the specified version now set as default. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4758,108 +2356,55 @@ paths: tags: - Conversations summary: List Items - description: |- - List items. - - List items in the conversation. operationId: list_items_v1_conversations__conversation_id__items_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - enum: - - asc - - desc - type: string - - type: 'null' - title: Order - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' - - name: include - in: query - required: false - schema: - anyOf: - - type: array - items: - $ref: '#/components/schemas/ConversationItemInclude' - - type: 'null' - title: Include - responses: - '200': - description: List of conversation items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Conversations summary: Add Items - description: |- - Create items. - - Create items in the conversation. operationId: add_items_v1_conversations__conversation_id__items_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_conversation_id_items_Request' responses: '200': - description: List of created items. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path @@ -4872,24 +2417,13 @@ paths: tags: - Conversations summary: Create Conversation - description: |- - Create a conversation. - - Create a conversation. operationId: create_conversation_v1_conversations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_Request' - required: true responses: '200': - description: The created conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4907,18 +2441,13 @@ paths: tags: - Conversations summary: Get Conversation - description: |- - Retrieve a conversation. - - Get a conversation with the given ID. operationId: get_conversation_v1_conversations__conversation_id__get responses: '200': - description: The conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4942,24 +2471,13 @@ paths: tags: - Conversations summary: Update Conversation - description: |- - Update a conversation. - - Update a conversation's metadata with the given ID. operationId: update_conversation_v1_conversations__conversation_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_conversation_id_Request' - required: true responses: '200': - description: The updated conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4983,18 +2501,13 @@ paths: tags: - Conversations summary: Openai Delete Conversation - description: |- - Delete a conversation. - - Delete a conversation with the given ID. operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': - description: The deleted conversation resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationDeletedResource' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -5019,18 +2532,13 @@ paths: tags: - Conversations summary: Retrieve - description: |- - Retrieve an item. - - Retrieve a conversation item. operationId: retrieve_v1_conversations__conversation_id__items__item_id__get responses: '200': - description: The conversation item. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseMessage' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -5060,18 +2568,13 @@ paths: tags: - Conversations summary: Openai Delete Conversation Item - description: |- - Delete an item. - - Delete a conversation item. operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete responses: '200': - description: The deleted item resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationItemDeletedResource' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -5098,5965 +2601,44 @@ paths: type: string description: 'Path parameter: item_id' components: + responses: + BadRequest400: + description: The request was invalid or malformed + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 400 + title: Bad Request + detail: The request was invalid or malformed + TooManyRequests429: + description: The client has sent too many requests in a given amount of time + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 429 + title: Too Many Requests + detail: You have exceeded the rate limit. Please try again later. + InternalServerError500: + description: The server encountered an unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 500 + title: Internal Server Error + detail: An unexpected error occurred + DefaultError: + description: An error occurred + content: + application/json: + schema: + $ref: '#/components/schemas/Error' schemas: - AggregationFunctionType: - type: string - enum: - - average - - weighted_average - - median - - categorical_count - - accuracy - title: AggregationFunctionType - description: Types of aggregation functions for scoring results. - AllowedToolsFilter: - properties: - tool_names: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: AllowedToolsFilter - description: Filter configuration for restricting which MCP tools can be used. - ApprovalFilter: - properties: - always: - anyOf: - - items: - type: string - type: array - - type: 'null' - never: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: ApprovalFilter - description: Filter configuration for MCP tool approval requirements. - ArrayType: - properties: - type: - type: string - const: array - title: Type - default: array - type: object - title: ArrayType - description: Parameter type for array values. - BasicScoringFnParams: - properties: - type: - type: string - const: basic - title: Type - default: basic - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: BasicScoringFnParams - description: Parameters for basic scoring function configuration. - Batch: - properties: - id: - type: string - title: Id - completion_window: - type: string - title: Completion Window - created_at: - type: integer - title: Created At - endpoint: - type: string - title: Endpoint - input_file_id: - type: string - title: Input File Id - object: - type: string - const: batch - title: Object - status: - type: string - enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled - title: Status - cancelled_at: - anyOf: - - type: integer - - type: 'null' - cancelling_at: - anyOf: - - type: integer - - type: 'null' - completed_at: - anyOf: - - type: integer - - type: 'null' - error_file_id: - anyOf: - - type: string - - type: 'null' - errors: - anyOf: - - $ref: '#/components/schemas/Errors' - title: Errors - - type: 'null' - title: Errors - expired_at: - anyOf: - - type: integer - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - failed_at: - anyOf: - - type: integer - - type: 'null' - finalizing_at: - anyOf: - - type: integer - - type: 'null' - in_progress_at: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - model: - anyOf: - - type: string - - type: 'null' - output_file_id: - anyOf: - - type: string - - type: 'null' - request_counts: - anyOf: - - $ref: '#/components/schemas/BatchRequestCounts' - title: BatchRequestCounts - - type: 'null' - title: BatchRequestCounts - usage: - anyOf: - - $ref: '#/components/schemas/BatchUsage' - title: BatchUsage - - type: 'null' - title: BatchUsage - additionalProperties: true - type: object - required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status - title: Batch - BatchError: - properties: - code: - anyOf: - - type: string - - type: 'null' - line: - anyOf: - - type: integer - - type: 'null' - message: - anyOf: - - type: string - - type: 'null' - param: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: BatchError - BatchRequestCounts: - properties: - completed: - type: integer - title: Completed - failed: - type: integer - title: Failed - total: - type: integer - title: Total - additionalProperties: true - type: object - required: - - completed - - failed - - total - title: BatchRequestCounts - BatchUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - input_tokens_details: - $ref: '#/components/schemas/InputTokensDetails' - output_tokens: - type: integer - title: Output Tokens - output_tokens_details: - $ref: '#/components/schemas/OutputTokensDetails' - total_tokens: - type: integer - title: Total Tokens - additionalProperties: true - type: object - required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens - title: BatchUsage - Benchmark: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: benchmark - title: Type - default: benchmark - dataset_id: - type: string - title: Dataset Id - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - metadata: - additionalProperties: true - type: object - title: Metadata - description: Metadata for this evaluation task - type: object - required: - - identifier - - provider_id - - dataset_id - - scoring_functions - title: Benchmark - description: A benchmark resource for evaluating model performance. - BenchmarkConfig: - properties: - eval_candidate: - $ref: '#/components/schemas/ModelCandidate' - scoring_params: - additionalProperties: - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: object - title: Scoring Params - description: Map between scoring function id and parameters for each scoring function you want to run - num_examples: - anyOf: - - type: integer - - type: 'null' - description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated - type: object - required: - - eval_candidate - title: BenchmarkConfig - description: A benchmark configuration for evaluation. - Body_openai_upload_file_v1_files_post: - properties: - file: - type: string - format: binary - title: File - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - expires_after: - anyOf: - - $ref: '#/components/schemas/ExpiresAfter' - title: ExpiresAfter - - type: 'null' - title: ExpiresAfter - type: object - required: - - file - - purpose - title: Body_openai_upload_file_v1_files_post - BooleanType: - properties: - type: - type: string - const: boolean - title: Type - default: boolean - type: object - title: BooleanType - description: Parameter type for boolean values. - ChatCompletionInputType: - properties: - type: - type: string - const: chat_completion_input - title: Type - default: chat_completion_input - type: object - title: ChatCompletionInputType - description: Parameter type for chat completion input. - Checkpoint: - properties: - identifier: - type: string - title: Identifier - created_at: - type: string - format: date-time - title: Created At - epoch: - type: integer - title: Epoch - post_training_job_id: - type: string - title: Post Training Job Id - path: - type: string - title: Path - training_metrics: - anyOf: - - $ref: '#/components/schemas/PostTrainingMetric' - title: PostTrainingMetric - - type: 'null' - title: PostTrainingMetric - type: object - required: - - identifier - - created_at - - epoch - - post_training_job_id - - path - title: Checkpoint - description: Checkpoint created during training runs. - Chunk-Input: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - Chunk-Output: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - title: string | list[ImageContentItem-Output | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - ChunkMetadata: - properties: - chunk_id: - anyOf: - - type: string - - type: 'null' - document_id: - anyOf: - - type: string - - type: 'null' - source: - anyOf: - - type: string - - type: 'null' - created_timestamp: - anyOf: - - type: integer - - type: 'null' - updated_timestamp: - anyOf: - - type: integer - - type: 'null' - chunk_window: - anyOf: - - type: string - - type: 'null' - chunk_tokenizer: - anyOf: - - type: string - - type: 'null' - chunk_embedding_model: - anyOf: - - type: string - - type: 'null' - chunk_embedding_dimension: - anyOf: - - type: integer - - type: 'null' - content_token_count: - anyOf: - - type: integer - - type: 'null' - metadata_token_count: - anyOf: - - type: integer - - type: 'null' - type: object - title: ChunkMetadata - description: |- - `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that - will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` - is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. - Use `Chunk.metadata` for metadata that will be used in the context during inference. - CompletionInputType: - properties: - type: - type: string - const: completion_input - title: Type - default: completion_input - type: object - title: CompletionInputType - description: Parameter type for completion input. - Conversation: - properties: - id: - type: string - title: Id - description: The unique ID of the conversation. - object: - type: string - const: conversation - title: Object - description: The object type, which is always conversation. - default: conversation - created_at: - type: integer - title: Created At - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. - items: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - description: Initial items to include in the conversation context. You may add up to 20 items at a time. - type: object - required: - - id - - created_at - title: Conversation - description: OpenAI-compatible conversation object. - ConversationDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted conversation identifier - object: - type: string - title: Object - description: Object type - default: conversation.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationDeletedResource - description: Response for deleted conversation. - ConversationItemDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted item identifier - object: - type: string - title: Object - description: Object type - default: conversation.item.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationItemDeletedResource - description: Response for deleted conversation item. - ConversationItemInclude: - type: string - enum: - - web_search_call.action.sources - - code_interpreter_call.outputs - - computer_call_output.output.image_url - - file_search_call.results - - message.input_image.image_url - - message.output_text.logprobs - - reasoning.encrypted_content - title: ConversationItemInclude - description: Specify additional output data to include in the model response. - ConversationItemList: - properties: - object: - type: string - title: Object - description: Object type - default: list - data: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (9 variants) - type: array - title: Data - description: List of conversation items - first_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the first item in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the last item in the list - has_more: - type: boolean - title: Has More - description: Whether there are more items available - default: false - type: object - required: - - data - title: ConversationItemList - description: List of conversation items with pagination. - DPOAlignmentConfig: - properties: - beta: - type: number - title: Beta - loss_type: - $ref: '#/components/schemas/DPOLossType' - default: sigmoid - type: object - required: - - beta - title: DPOAlignmentConfig - description: Configuration for Direct Preference Optimization (DPO) alignment. - DPOLossType: - type: string - enum: - - sigmoid - - hinge - - ipo - - kto_pair - title: DPOLossType - DataConfig: - properties: - dataset_id: - type: string - title: Dataset Id - batch_size: - type: integer - title: Batch Size - shuffle: - type: boolean - title: Shuffle - data_format: - $ref: '#/components/schemas/DatasetFormat' - validation_dataset_id: - anyOf: - - type: string - - type: 'null' - packed: - anyOf: - - type: boolean - - type: 'null' - default: false - train_on_input: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - dataset_id - - batch_size - - shuffle - - data_format - title: DataConfig - description: Configuration for training data and data loading. - Dataset: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: dataset - title: Type - default: dataset - purpose: - $ref: '#/components/schemas/DatasetPurpose' - source: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource - discriminator: - propertyName: type - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this dataset - type: object - required: - - identifier - - provider_id - - purpose - - source - title: Dataset - description: Dataset resource for storing and accessing training or evaluation data. - DatasetFormat: - type: string - enum: - - instruct - - dialog - title: DatasetFormat - description: Format of the training dataset. - DatasetPurpose: - type: string - enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - title: DatasetPurpose - description: Purpose of the dataset. Each purpose has a required input data schema. - EfficiencyConfig: - properties: - enable_activation_checkpointing: - anyOf: - - type: boolean - - type: 'null' - default: false - enable_activation_offloading: - anyOf: - - type: boolean - - type: 'null' - default: false - memory_efficient_fsdp_wrap: - anyOf: - - type: boolean - - type: 'null' - default: false - fsdp_cpu_offload: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - title: EfficiencyConfig - description: Configuration for memory and compute efficiency optimizations. - Errors: - properties: - data: - anyOf: - - items: - $ref: '#/components/schemas/BatchError' - type: array - - type: 'null' - object: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: Errors - EvaluateResponse: - properties: - generations: - items: - additionalProperties: true - type: object - type: array - title: Generations - scores: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Scores - type: object - required: - - generations - - scores - title: EvaluateResponse - description: The response from an evaluation. - ExpiresAfter: - properties: - anchor: - type: string - const: created_at - title: Anchor - seconds: - type: integer - maximum: 2592000.0 - minimum: 3600.0 - title: Seconds - type: object - required: - - anchor - - seconds - title: ExpiresAfter - description: |- - Control expiration of uploaded files. - - Params: - - anchor, must be "created_at" - - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) - GreedySamplingStrategy: - properties: - type: - type: string - const: greedy - title: Type - default: greedy - type: object - title: GreedySamplingStrategy - description: Greedy sampling strategy that selects the highest probability token at each step. - HealthInfo: - properties: - status: - $ref: '#/components/schemas/HealthStatus' - type: object - required: - - status - title: HealthInfo - description: Health status information for the service. - HealthStatus: - type: string - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - ImageContentItem-Input: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - ImageContentItem-Output: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - InputTokensDetails: - properties: - cached_tokens: - type: integer - title: Cached Tokens - additionalProperties: true - type: object - required: - - cached_tokens - title: InputTokensDetails - Job: - properties: - job_id: - type: string - title: Job Id - status: - $ref: '#/components/schemas/JobStatus' - type: object - required: - - job_id - - status - title: Job - description: A job execution instance with status tracking. - JobStatus: - type: string - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - description: Status of a job execution. - JsonType: - properties: - type: - type: string - const: json - title: Type - default: json - type: object - title: JsonType - description: Parameter type for JSON values. - LLMAsJudgeScoringFnParams: - properties: - type: - type: string - const: llm_as_judge - title: Type - default: llm_as_judge - judge_model: - type: string - title: Judge Model - prompt_template: - anyOf: - - type: string - - type: 'null' - judge_score_regexes: - items: - type: string - type: array - title: Judge Score Regexes - description: Regexes to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - required: - - judge_model - title: LLMAsJudgeScoringFnParams - description: Parameters for LLM-as-judge scoring function configuration. - ListBatchesResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/Batch' - type: array - title: Data - description: List of batch objects - first_id: - anyOf: - - type: string - - type: 'null' - description: ID of the first batch in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: ID of the last batch in the list - has_more: - type: boolean - title: Has More - description: Whether there are more batches available - default: false - type: object - required: - - data - title: ListBatchesResponse - description: Response containing a list of batch objects. - ListBenchmarksResponse: - properties: - data: - items: - $ref: '#/components/schemas/Benchmark' - type: array - title: Data - type: object - required: - - data - title: ListBenchmarksResponse - ListDatasetsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Dataset' - type: array - title: Data - type: object - required: - - data - title: ListDatasetsResponse - description: Response from listing datasets. - ListOpenAIChatCompletionResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIChatCompletionResponse - description: Response from listing OpenAI-compatible chat completions. - ListOpenAIFileResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIFileObject' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIFileResponse - description: Response for listing files in OpenAI Files API. - ListOpenAIResponseInputItem: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Data - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - title: ListOpenAIResponseInputItem - description: List container for OpenAI response input items. - ListOpenAIResponseObject: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseObjectWithInput-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIResponseObject - description: Paginated list of OpenAI response objects with navigation metadata. - ListPostTrainingJobsResponse: - properties: - data: - items: - $ref: '#/components/schemas/PostTrainingJob' - type: array - title: Data - type: object - required: - - data - title: ListPostTrainingJobsResponse - ListPromptsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Prompt' - type: array - title: Data - type: object - required: - - data - title: ListPromptsResponse - description: Response model to list prompts. - ListProvidersResponse: - properties: - data: - items: - $ref: '#/components/schemas/ProviderInfo' - type: array - title: Data - type: object - required: - - data - title: ListProvidersResponse - description: Response containing a list of all available providers. - ListRoutesResponse: - properties: - data: - items: - $ref: '#/components/schemas/RouteInfo' - type: array - title: Data - type: object - required: - - data - title: ListRoutesResponse - description: Response containing a list of all available API routes. - ListScoringFunctionsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ScoringFn' - type: array - title: Data - type: object - required: - - data - title: ListScoringFunctionsResponse - ListShieldsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Shield' - type: array - title: Data - type: object - required: - - data - title: ListShieldsResponse - ListToolDefsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolDef' - type: array - title: Data - type: object - required: - - data - title: ListToolDefsResponse - description: Response containing a list of tool definitions. - ListToolGroupsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolGroup' - type: array - title: Data - type: object - required: - - data - title: ListToolGroupsResponse - description: Response containing a list of tool groups. - LoraFinetuningConfig: - properties: - type: - type: string - const: LoRA - title: Type - default: LoRA - lora_attn_modules: - items: - type: string - type: array - title: Lora Attn Modules - apply_lora_to_mlp: - type: boolean - title: Apply Lora To Mlp - apply_lora_to_output: - type: boolean - title: Apply Lora To Output - rank: - type: integer - title: Rank - alpha: - type: integer - title: Alpha - use_dora: - anyOf: - - type: boolean - - type: 'null' - default: false - quantize_base: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - title: LoraFinetuningConfig - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. - MCPListToolsTool: - properties: - input_schema: - additionalProperties: true - type: object - title: Input Schema - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_schema - - name - title: MCPListToolsTool - description: Tool definition returned by MCP list tools operation. - Model: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: model - title: Type - default: model - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this model - model_type: - $ref: '#/components/schemas/ModelType' - default: llm - type: object - required: - - identifier - - provider_id - title: Model - description: A model resource representing an AI model registered in Llama Stack. - ModelCandidate: - properties: - type: - type: string - const: model - title: Type - default: model - model: - type: string - title: Model - sampling_params: - $ref: '#/components/schemas/SamplingParams' - system_message: - anyOf: - - $ref: '#/components/schemas/SystemMessage' - title: SystemMessage - - type: 'null' - title: SystemMessage - type: object - required: - - model - - sampling_params - title: ModelCandidate - description: A model candidate for evaluation. - ModelType: - type: string - enum: - - llm - - embedding - - rerank - title: ModelType - description: Enumeration of supported model types in Llama Stack. - ModerationObject: - properties: - id: - type: string - title: Id - model: - type: string - title: Model - results: - items: - $ref: '#/components/schemas/ModerationObjectResults' - type: array - title: Results - type: object - required: - - id - - model - - results - title: ModerationObject - description: A moderation object. - ModerationObjectResults: - properties: - flagged: - type: boolean - title: Flagged - categories: - anyOf: - - additionalProperties: - type: boolean - type: object - - type: 'null' - category_applied_input_types: - anyOf: - - additionalProperties: - items: - type: string - type: array - type: object - - type: 'null' - category_scores: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - flagged - title: ModerationObjectResults - description: A moderation object. - NumberType: - properties: - type: - type: string - const: number - title: Type - default: number - type: object - title: NumberType - description: Parameter type for numeric values. - ObjectType: - properties: - type: - type: string - const: object - title: Type - default: object - type: object - title: ObjectType - description: Parameter type for object values. - OpenAIAssistantMessageParam-Input: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIAssistantMessageParam-Output: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIChatCompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - type: object - required: - - id - - choices - - created - - model - title: OpenAIChatCompletion - description: Response from an OpenAI-compatible chat completion request. - OpenAIChatCompletionContentPartImageParam: - properties: - type: - type: string - const: image_url - title: Type - default: image_url - image_url: - $ref: '#/components/schemas/OpenAIImageURL' - type: object - required: - - image_url - title: OpenAIChatCompletionContentPartImageParam - description: Image content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionContentPartTextParam: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: OpenAIChatCompletionContentPartTextParam - description: Text content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' - title: OpenAIAssistantMessageParam-Input - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input | ... (5 variants) - type: array - minItems: 1 - title: Messages - frequency_penalty: - anyOf: - - type: number - - type: 'null' - function_call: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - functions: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_completion_tokens: - anyOf: - - type: integer - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - response_format: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - title: OpenAIResponseFormatJSONSchema - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' - title: OpenAIResponseFormatJSONObject - discriminator: - propertyName: type - mapping: - json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' - json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' - text: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - - type: 'null' - title: Response Format - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - tool_choice: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - tools: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - top_logprobs: - anyOf: - - type: integer - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - messages - title: OpenAIChatCompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible chat completion endpoint. - OpenAIChatCompletionToolCall: - properties: - index: - anyOf: - - type: integer - - type: 'null' - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - const: function - title: Type - default: function - function: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' - title: OpenAIChatCompletionToolCallFunction - - type: 'null' - title: OpenAIChatCompletionToolCallFunction - type: object - title: OpenAIChatCompletionToolCall - description: Tool call specification for OpenAI-compatible chat completion responses. - OpenAIChatCompletionToolCallFunction: - properties: - name: - anyOf: - - type: string - - type: 'null' - arguments: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIChatCompletionToolCallFunction - description: Function call details for OpenAI-compatible tool calls. - OpenAIChatCompletionUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - completion_tokens: - type: integer - title: Completion Tokens - total_tokens: - type: integer - title: Total Tokens - prompt_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' - title: OpenAIChatCompletionUsagePromptTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsagePromptTokensDetails - completion_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' - title: OpenAIChatCompletionUsageCompletionTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsageCompletionTokensDetails - type: object - required: - - prompt_tokens - - completion_tokens - - total_tokens - title: OpenAIChatCompletionUsage - description: Usage information for OpenAI chat completion. - OpenAIChatCompletionUsageCompletionTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsageCompletionTokensDetails - description: Token details for output tokens in OpenAI chat completion usage. - OpenAIChatCompletionUsagePromptTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsagePromptTokensDetails - description: Token details for prompt tokens in OpenAI chat completion usage. - OpenAIChoice-Output: - properties: - message: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam-Output | ... (5 variants) - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - finish_reason: - type: string - title: Finish Reason - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - message - - finish_reason - - index - title: OpenAIChoice - description: A choice from an OpenAI-compatible chat completion response. - OpenAIChoiceLogprobs-Output: - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - type: object - title: OpenAIChoiceLogprobs - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - OpenAICompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAICompletionChoice-Output' - type: array - title: Choices - created: - type: integer - title: Created - model: - type: string - title: Model - object: - type: string - const: text_completion - title: Object - default: text_completion - type: object - required: - - id - - choices - - created - - model - title: OpenAICompletion - description: |- - Response from an OpenAI-compatible completion request. - - :id: The ID of the completion - :choices: List of choices - :created: The Unix timestamp in seconds when the completion was created - :model: The model that was used to generate the completion - :object: The object type, which will be "text_completion" - OpenAICompletionChoice-Output: - properties: - finish_reason: - type: string - title: Finish Reason - text: - type: string - title: Text - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - finish_reason - - text - - index - title: OpenAICompletionChoice - description: |- - A choice from an OpenAI-compatible completion response. - - :finish_reason: The reason the model stopped generating - :text: The text of the choice - :index: The index of the choice - :logprobs: (Optional) The log probabilities for the tokens in the choice - OpenAICompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - prompt: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - items: - type: integer - type: array - title: list[integer] - - items: - items: - type: integer - type: array - type: array - title: list[array] - title: string | ... (4 variants) - best_of: - anyOf: - - type: integer - - type: 'null' - echo: - anyOf: - - type: boolean - - type: 'null' - frequency_penalty: - anyOf: - - type: number - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - suffix: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - prompt - title: OpenAICompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible completion endpoint. - OpenAICompletionWithInputMessages: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - input_messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output | ... (5 variants) - type: array - title: Input Messages - type: object - required: - - id - - choices - - created - - model - - input_messages - title: OpenAICompletionWithInputMessages - OpenAICreateVectorStoreFileBatchRequestWithExtraBody: - properties: - file_ids: - items: - type: string - type: array - title: File Ids - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - additionalProperties: true - type: object - required: - - file_ids - title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: Request to create a vector store file batch with extra_body support. - OpenAICreateVectorStoreRequestWithExtraBody: - properties: - name: - anyOf: - - type: string - - type: 'null' - file_ids: - anyOf: - - items: - type: string - type: array - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - additionalProperties: true - type: object - title: OpenAICreateVectorStoreRequestWithExtraBody - description: Request to create a vector store with extra_body support. - OpenAIDeleteResponseObject: - properties: - id: - type: string - title: Id - object: - type: string - const: response - title: Object - default: response - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: OpenAIDeleteResponseObject - description: Response object confirming deletion of an OpenAI response. - OpenAIDeveloperMessageParam: - properties: - role: - type: string - const: developer - title: Role - default: developer - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIDeveloperMessageParam - description: A message from the developer in an OpenAI-compatible chat completion request. - OpenAIEmbeddingData: - properties: - object: - type: string - const: embedding - title: Object - default: embedding - embedding: - anyOf: - - items: - type: number - type: array - title: list[number] - - type: string - title: list[number] | string - index: - type: integer - title: Index - type: object - required: - - embedding - - index - title: OpenAIEmbeddingData - description: A single embedding data object from an OpenAI-compatible embeddings response. - OpenAIEmbeddingUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - total_tokens: - type: integer - title: Total Tokens - type: object - required: - - prompt_tokens - - total_tokens - title: OpenAIEmbeddingUsage - description: Usage information for an OpenAI-compatible embeddings response. - OpenAIEmbeddingsRequestWithExtraBody: - properties: - model: - type: string - title: Model - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - encoding_format: - anyOf: - - type: string - - type: 'null' - default: float - dimensions: - anyOf: - - type: integer - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - input - title: OpenAIEmbeddingsRequestWithExtraBody - description: Request parameters for OpenAI-compatible embeddings endpoint. - OpenAIEmbeddingsResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/OpenAIEmbeddingData' - type: array - title: Data - model: - type: string - title: Model - usage: - $ref: '#/components/schemas/OpenAIEmbeddingUsage' - type: object - required: - - data - - model - - usage - title: OpenAIEmbeddingsResponse - description: Response from an OpenAI-compatible embeddings request. - OpenAIFile: - properties: - type: - type: string - const: file - title: Type - default: file - file: - $ref: '#/components/schemas/OpenAIFileFile' - type: object - required: - - file - title: OpenAIFile - OpenAIFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - const: file - title: Object - default: file - deleted: - type: boolean - title: Deleted - type: object - required: - - id - - deleted - title: OpenAIFileDeleteResponse - description: Response for deleting a file in OpenAI Files API. - OpenAIFileFile: - properties: - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIFileFile - OpenAIFileObject: - properties: - object: - type: string - const: file - title: Object - default: file - id: - type: string - title: Id - bytes: - type: integer - title: Bytes - created_at: - type: integer - title: Created At - expires_at: - type: integer - title: Expires At - filename: - type: string - title: Filename - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - type: object - required: - - id - - bytes - - created_at - - expires_at - - filename - - purpose - title: OpenAIFileObject - description: OpenAI File object as defined in the OpenAI Files API. - OpenAIFilePurpose: - type: string - enum: - - assistants - - batch - title: OpenAIFilePurpose - description: Valid purpose values for OpenAI Files API. - OpenAIImageURL: - properties: - url: - type: string - title: Url - detail: - anyOf: - - type: string - - type: 'null' - type: object - required: - - url - title: OpenAIImageURL - description: Image URL specification for OpenAI-compatible chat completion messages. - OpenAIJSONSchema: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: OpenAIJSONSchema - description: JSON schema specification for OpenAI-compatible structured response format. - OpenAIListModelsResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIModel' - type: array - title: Data - type: object - required: - - data - title: OpenAIListModelsResponse - OpenAIModel: - properties: - id: - type: string - title: Id - object: - type: string - const: model - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - custom_metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - id - - created - - owned_by - title: OpenAIModel - description: |- - A model from OpenAI. - - :id: The ID of the model - :object: The object type, which will be "model" - :created: The Unix timestamp in seconds when the model was created - :owned_by: The owner of the model - :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata - OpenAIResponseAnnotationCitation: - properties: - type: - type: string - const: url_citation - title: Type - default: url_citation - end_index: - type: integer - title: End Index - start_index: - type: integer - title: Start Index - title: - type: string - title: Title - url: - type: string - title: Url - type: object - required: - - end_index - - start_index - - title - - url - title: OpenAIResponseAnnotationCitation - description: URL citation annotation for referencing external web resources. - OpenAIResponseAnnotationContainerFileCitation: - properties: - type: - type: string - const: container_file_citation - title: Type - default: container_file_citation - container_id: - type: string - title: Container Id - end_index: - type: integer - title: End Index - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - start_index: - type: integer - title: Start Index - type: object - required: - - container_id - - end_index - - file_id - - filename - - start_index - title: OpenAIResponseAnnotationContainerFileCitation - OpenAIResponseAnnotationFileCitation: - properties: - type: - type: string - const: file_citation - title: Type - default: file_citation - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - index: - type: integer - title: Index - type: object - required: - - file_id - - filename - - index - title: OpenAIResponseAnnotationFileCitation - description: File citation annotation for referencing specific files in response content. - OpenAIResponseAnnotationFilePath: - properties: - type: - type: string - const: file_path - title: Type - default: file_path - file_id: - type: string - title: File Id - index: - type: integer - title: Index - type: object - required: - - file_id - - index - title: OpenAIResponseAnnotationFilePath - OpenAIResponseContentPartRefusal: - properties: - type: - type: string - const: refusal - title: Type - default: refusal - refusal: - type: string - title: Refusal - type: object - required: - - refusal - title: OpenAIResponseContentPartRefusal - description: Refusal content within a streamed response part. - OpenAIResponseError: - properties: - code: - type: string - title: Code - message: - type: string - title: Message - type: object - required: - - code - - message - title: OpenAIResponseError - description: Error details for failed OpenAI response requests. - OpenAIResponseFormatJSONObject: - properties: - type: - type: string - const: json_object - title: Type - default: json_object - type: object - title: OpenAIResponseFormatJSONObject - description: JSON object response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatJSONSchema: - properties: - type: - type: string - const: json_schema - title: Type - default: json_schema - json_schema: - $ref: '#/components/schemas/OpenAIJSONSchema' - type: object - required: - - json_schema - title: OpenAIResponseFormatJSONSchema - description: JSON schema response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatText: - properties: - type: - type: string - const: text - title: Type - default: text - type: object - title: OpenAIResponseFormatText - description: Text response format for OpenAI-compatible chat completion requests. - OpenAIResponseInputFunctionToolCallOutput: - properties: - call_id: - type: string - title: Call Id - output: - type: string - title: Output - type: - type: string - const: function_call_output - title: Type - default: function_call_output - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - output - title: OpenAIResponseInputFunctionToolCallOutput - description: This represents the output of a function call that gets passed back to the model. - OpenAIResponseInputMessageContentFile: - properties: - type: - type: string - const: input_file - title: Type - default: input_file - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - file_url: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentFile - description: File content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentImage: - properties: - detail: - title: Detail - default: auto - type: string - enum: - - low - - high - - auto - type: - type: string - const: input_image - title: Type - default: input_image - file_id: - anyOf: - - type: string - - type: 'null' - image_url: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentImage - description: Image content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentText: - properties: - text: - type: string - title: Text - type: - type: string - const: input_text - title: Type - default: input_text - type: object - required: - - text - title: OpenAIResponseInputMessageContentText - description: Text content for input messages in OpenAI response format. - OpenAIResponseInputToolFileSearch: - properties: - type: - type: string - const: file_search - title: Type - default: file_search - vector_store_ids: - items: - type: string - type: array - title: Vector Store Ids - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - maximum: 50.0 - minimum: 1.0 - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - type: object - required: - - vector_store_ids - title: OpenAIResponseInputToolFileSearch - description: File search tool configuration for OpenAI response inputs. - OpenAIResponseInputToolFunction: - properties: - type: - type: string - const: function - title: Type - default: function - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - required: - - name - - parameters - title: OpenAIResponseInputToolFunction - description: Function tool configuration for OpenAI response inputs. - OpenAIResponseInputToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - server_url: - type: string - title: Server Url - headers: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - require_approval: - anyOf: - - type: string - const: always - - type: string - const: never - - $ref: '#/components/schemas/ApprovalFilter' - title: ApprovalFilter - title: string | ApprovalFilter - default: never - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - - server_url - title: OpenAIResponseInputToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. - OpenAIResponseInputToolWebSearch: - properties: - type: - title: Type - default: web_search - type: string - enum: - - web_search - - web_search_preview - - web_search_preview_2025_03_11 - - web_search_2025_08_26 - search_context_size: - anyOf: - - type: string - pattern: ^low|medium|high$ - - type: 'null' - default: medium - type: object - title: OpenAIResponseInputToolWebSearch - description: Web search tool configuration for OpenAI response inputs. - OpenAIResponseMCPApprovalRequest: - properties: - arguments: - type: string - title: Arguments - id: - type: string - title: Id - name: - type: string - title: Name - server_label: - type: string - title: Server Label - type: - type: string - const: mcp_approval_request - title: Type - default: mcp_approval_request - type: object - required: - - arguments - - id - - name - - server_label - title: OpenAIResponseMCPApprovalRequest - description: A request for human approval of a tool invocation. - OpenAIResponseMCPApprovalResponse: - properties: - approval_request_id: - type: string - title: Approval Request Id - approve: - type: boolean - title: Approve - type: - type: string - const: mcp_approval_response - title: Type - default: mcp_approval_response - id: - anyOf: - - type: string - - type: 'null' - reason: - anyOf: - - type: string - - type: 'null' - type: object - required: - - approval_request_id - - approve - title: OpenAIResponseMCPApprovalResponse - description: A response to an MCP approval request. - OpenAIResponseMessage-Input: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseMessage-Output: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseObject: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - created_at - - id - - model - - output - - status - title: OpenAIResponseObject - description: Complete OpenAI response object containing generation results and metadata. - OpenAIResponseObjectWithInput-Output: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - input: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Input - type: object - required: - - created_at - - id - - model - - output - - status - - input - title: OpenAIResponseObjectWithInput - description: OpenAI response object extended with input context information. - OpenAIResponseOutputMessageContentOutputText: - properties: - text: - type: string - title: Text - type: - type: string - const: output_text - title: Type - default: output_text - annotations: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - title: OpenAIResponseAnnotationFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - title: OpenAIResponseAnnotationContainerFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - title: OpenAIResponseAnnotationFilePath - discriminator: - propertyName: type - mapping: - container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' - url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - type: array - title: Annotations - type: object - required: - - text - title: OpenAIResponseOutputMessageContentOutputText - OpenAIResponseOutputMessageFileSearchToolCall: - properties: - id: - type: string - title: Id - queries: - items: - type: string - type: array - title: Queries - status: - type: string - title: Status - type: - type: string - const: file_search_call - title: Type - default: file_search_call - results: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' - type: array - - type: 'null' - type: object - required: - - id - - queries - - status - title: OpenAIResponseOutputMessageFileSearchToolCall - description: File search tool call output message for OpenAI responses. - OpenAIResponseOutputMessageFileSearchToolCallResults: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - text: - type: string - title: Text - type: object - required: - - attributes - - file_id - - filename - - score - - text - title: OpenAIResponseOutputMessageFileSearchToolCallResults - description: Search results returned by the file search operation. - OpenAIResponseOutputMessageFunctionToolCall: - properties: - call_id: - type: string - title: Call Id - name: - type: string - title: Name - arguments: - type: string - title: Arguments - type: - type: string - const: function_call - title: Type - default: function_call - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - name - - arguments - title: OpenAIResponseOutputMessageFunctionToolCall - description: Function tool call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPCall: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_call - title: Type - default: mcp_call - arguments: - type: string - title: Arguments - name: - type: string - title: Name - server_label: - type: string - title: Server Label - error: - anyOf: - - type: string - - type: 'null' - output: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - - arguments - - name - - server_label - title: OpenAIResponseOutputMessageMCPCall - description: Model Context Protocol (MCP) call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPListTools: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_list_tools - title: Type - default: mcp_list_tools - server_label: - type: string - title: Server Label - tools: - items: - $ref: '#/components/schemas/MCPListToolsTool' - type: array - title: Tools - type: object - required: - - id - - server_label - - tools - title: OpenAIResponseOutputMessageMCPListTools - description: MCP list tools output message containing available tools from an MCP server. - OpenAIResponseOutputMessageWebSearchToolCall: - properties: - id: - type: string - title: Id - status: - type: string - title: Status - type: - type: string - const: web_search_call - title: Type - default: web_search_call - type: object - required: - - id - - status - title: OpenAIResponseOutputMessageWebSearchToolCall - description: Web search tool call output message for OpenAI responses. - OpenAIResponsePrompt: - properties: - id: - type: string - title: Id - variables: - anyOf: - - additionalProperties: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: object - - type: 'null' - version: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - title: OpenAIResponsePrompt - description: OpenAI compatible Prompt object that is used in OpenAI responses. - OpenAIResponseText: - properties: - format: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseTextFormat' - title: OpenAIResponseTextFormat - - type: 'null' - title: OpenAIResponseTextFormat - type: object - title: OpenAIResponseText - description: Text response configuration for OpenAI responses. - OpenAIResponseTextFormat: - properties: - type: - title: Type - type: string - enum: - - text - - json_schema - - json_object - default: text - name: - anyOf: - - type: string - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - title: OpenAIResponseTextFormat - description: Configuration for Responses API text format. - OpenAIResponseToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - title: OpenAIResponseToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. - OpenAIResponseUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - output_tokens: - type: integer - title: Output Tokens - total_tokens: - type: integer - title: Total Tokens - input_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' - title: OpenAIResponseUsageInputTokensDetails - - type: 'null' - title: OpenAIResponseUsageInputTokensDetails - output_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' - title: OpenAIResponseUsageOutputTokensDetails - - type: 'null' - title: OpenAIResponseUsageOutputTokensDetails - type: object - required: - - input_tokens - - output_tokens - - total_tokens - title: OpenAIResponseUsage - description: Usage information for OpenAI response. - OpenAIResponseUsageInputTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageInputTokensDetails - description: Token details for input tokens in OpenAI response usage. - OpenAIResponseUsageOutputTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageOutputTokensDetails - description: Token details for output tokens in OpenAI response usage. - OpenAISystemMessageParam: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAISystemMessageParam - description: A system message providing instructions or context to the model. - OpenAITokenLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - top_logprobs: - items: - $ref: '#/components/schemas/OpenAITopLogProb' - type: array - title: Top Logprobs - type: object - required: - - token - - logprob - - top_logprobs - title: OpenAITokenLogProb - description: |- - The log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - :top_logprobs: The top log probabilities for the token - OpenAIToolMessageParam: - properties: - role: - type: string - const: tool - title: Role - default: tool - tool_call_id: - type: string - title: Tool Call Id - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - type: object - required: - - tool_call_id - - content - title: OpenAIToolMessageParam - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. - OpenAITopLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - type: object - required: - - token - - logprob - title: OpenAITopLogProb - description: |- - The top log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - OpenAIUserMessageParam-Input: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OpenAIUserMessageParam-Output: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OptimizerConfig: - properties: - optimizer_type: - $ref: '#/components/schemas/OptimizerType' - lr: - type: number - title: Lr - weight_decay: - type: number - title: Weight Decay - num_warmup_steps: - type: integer - title: Num Warmup Steps - type: object - required: - - optimizer_type - - lr - - weight_decay - - num_warmup_steps - title: OptimizerConfig - description: Configuration parameters for the optimization algorithm. - OptimizerType: - type: string - enum: - - adam - - adamw - - sgd - title: OptimizerType - description: Available optimizer algorithms for training. - Order: - type: string - enum: - - asc - - desc - title: Order - description: Sort order for paginated responses. - OutputTokensDetails: - properties: - reasoning_tokens: - type: integer - title: Reasoning Tokens - additionalProperties: true - type: object - required: - - reasoning_tokens - title: OutputTokensDetails - PaginatedResponse: - properties: - data: - items: - additionalProperties: true - type: object - type: array - title: Data - has_more: - type: boolean - title: Has More - url: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - - has_more - title: PaginatedResponse - description: A generic paginated response that follows a simple format. - PostTrainingJob: - properties: - job_uuid: - type: string - title: Job Uuid - type: object - required: - - job_uuid - title: PostTrainingJob - PostTrainingJobArtifactsResponse: - properties: - job_uuid: - type: string - title: Job Uuid - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - title: PostTrainingJobArtifactsResponse - description: Artifacts of a finetuning job. - PostTrainingJobStatusResponse: - properties: - job_uuid: - type: string - title: Job Uuid - status: - $ref: '#/components/schemas/JobStatus' - scheduled_at: - anyOf: - - type: string - format: date-time - - type: 'null' - started_at: - anyOf: - - type: string - format: date-time - - type: 'null' - completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' - resources_allocated: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - - status - title: PostTrainingJobStatusResponse - description: Status of a finetuning job. - PostTrainingMetric: - properties: - epoch: - type: integer - title: Epoch - train_loss: - type: number - title: Train Loss - validation_loss: - type: number - title: Validation Loss - perplexity: - type: number - title: Perplexity - type: object - required: - - epoch - - train_loss - - validation_loss - - perplexity - title: PostTrainingMetric - description: Training metrics captured during post-training jobs. - Prompt: - properties: - prompt: - anyOf: - - type: string - - type: 'null' - description: The system prompt with variable placeholders - version: - type: integer - minimum: 1.0 - title: Version - description: Version (integer starting at 1, incremented on save) - prompt_id: - type: string - title: Prompt Id - description: Unique identifier in format 'pmpt_<48-digit-hash>' - variables: - items: - type: string - type: array - title: Variables - description: List of variable names that can be used in the prompt template - is_default: - type: boolean - title: Is Default - description: Boolean indicating whether this version is the default version - default: false - type: object - required: - - version - - prompt_id - title: Prompt - description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. - ProviderInfo: - properties: - api: - type: string - title: Api - provider_id: - type: string - title: Provider Id - provider_type: - type: string - title: Provider Type - config: - additionalProperties: true - type: object - title: Config - health: - additionalProperties: true - type: object - title: Health - type: object - required: - - api - - provider_id - - provider_type - - config - - health - title: ProviderInfo - description: Information about a registered provider including its configuration and health status. - QATFinetuningConfig: - properties: - type: - type: string - const: QAT - title: Type - default: QAT - quantizer_name: - type: string - title: Quantizer Name - group_size: - type: integer - title: Group Size - type: object - required: - - quantizer_name - - group_size - title: QATFinetuningConfig - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. - QueryChunksResponse: - properties: - chunks: - items: - $ref: '#/components/schemas/Chunk-Output' - type: array - title: Chunks - scores: - items: - type: number - type: array - title: Scores - type: object - required: - - chunks - - scores - title: QueryChunksResponse - description: Response from querying chunks in a vector database. - RegexParserScoringFnParams: - properties: - type: - type: string - const: regex_parser - title: Type - default: regex_parser - parsing_regexes: - items: - type: string - type: array - title: Parsing Regexes - description: Regex to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: RegexParserScoringFnParams - description: Parameters for regex parser scoring function configuration. - RerankData: - properties: - index: - type: integer - title: Index - relevance_score: - type: number - title: Relevance Score - type: object - required: - - index - - relevance_score - title: RerankData - description: A single rerank result from a reranking response. - RerankResponse: - properties: - data: - items: - $ref: '#/components/schemas/RerankData' - type: array - title: Data - type: object - required: - - data - title: RerankResponse - description: Response from a reranking request. - RouteInfo: - properties: - route: - type: string - title: Route - method: - type: string - title: Method - provider_types: - items: - type: string - type: array - title: Provider Types - type: object - required: - - route - - method - - provider_types - title: RouteInfo - description: Information about an API route including its path, method, and implementing providers. - RowsDataSource: - properties: - type: - type: string - const: rows - title: Type - default: rows - rows: - items: - additionalProperties: true - type: object - type: array - title: Rows - type: object - required: - - rows - title: RowsDataSource - description: A dataset stored in rows. - RunShieldResponse: - properties: - violation: - anyOf: - - $ref: '#/components/schemas/SafetyViolation' - title: SafetyViolation - - type: 'null' - title: SafetyViolation - type: object - title: RunShieldResponse - description: Response from running a safety shield. - SafetyViolation: - properties: - violation_level: - $ref: '#/components/schemas/ViolationLevel' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - violation_level - title: SafetyViolation - description: Details of a safety violation detected by content moderation. - SamplingParams: - properties: - strategy: - oneOf: - - $ref: '#/components/schemas/GreedySamplingStrategy' - title: GreedySamplingStrategy - - $ref: '#/components/schemas/TopPSamplingStrategy' - title: TopPSamplingStrategy - - $ref: '#/components/schemas/TopKSamplingStrategy' - title: TopKSamplingStrategy - title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy - discriminator: - propertyName: type - mapping: - greedy: '#/components/schemas/GreedySamplingStrategy' - top_k: '#/components/schemas/TopKSamplingStrategy' - top_p: '#/components/schemas/TopPSamplingStrategy' - max_tokens: - anyOf: - - type: integer - - type: 'null' - repetition_penalty: - anyOf: - - type: number - - type: 'null' - default: 1.0 - stop: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: SamplingParams - description: Sampling parameters. - ScoreBatchResponse: - properties: - dataset_id: - anyOf: - - type: string - - type: 'null' - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreBatchResponse - description: Response from batch scoring operations on datasets. - ScoreResponse: - properties: - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreResponse - description: The response from scoring. - ScoringFn: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: scoring_function - title: Type - default: scoring_function - description: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this definition - return_type: - oneOf: - - $ref: '#/components/schemas/StringType' - title: StringType - - $ref: '#/components/schemas/NumberType' - title: NumberType - - $ref: '#/components/schemas/BooleanType' - title: BooleanType - - $ref: '#/components/schemas/ArrayType' - title: ArrayType - - $ref: '#/components/schemas/ObjectType' - title: ObjectType - - $ref: '#/components/schemas/JsonType' - title: JsonType - - $ref: '#/components/schemas/UnionType' - title: UnionType - - $ref: '#/components/schemas/ChatCompletionInputType' - title: ChatCompletionInputType - - $ref: '#/components/schemas/CompletionInputType' - title: CompletionInputType - title: StringType | ... (9 variants) - description: The return type of the deterministic function - discriminator: - propertyName: type - mapping: - array: '#/components/schemas/ArrayType' - boolean: '#/components/schemas/BooleanType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - json: '#/components/schemas/JsonType' - number: '#/components/schemas/NumberType' - object: '#/components/schemas/ObjectType' - string: '#/components/schemas/StringType' - union: '#/components/schemas/UnionType' - params: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: Params - description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval - type: object - required: - - identifier - - provider_id - - return_type - title: ScoringFn - description: A scoring function resource for evaluating model outputs. - ScoringResult: - properties: - score_rows: - items: - additionalProperties: true - type: object - type: array - title: Score Rows - aggregated_results: - additionalProperties: true - type: object - title: Aggregated Results - type: object - required: - - score_rows - - aggregated_results - title: ScoringResult - description: A scoring result for a single row. - SearchRankingOptions: - properties: - ranker: - anyOf: - - type: string - - type: 'null' - score_threshold: - anyOf: - - type: number - - type: 'null' - default: 0.0 - type: object - title: SearchRankingOptions - description: Options for ranking and filtering search results. - Shield: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: shield - title: Type - default: shield - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: Shield - description: A safety shield resource that can be used to check content. - StringType: - properties: - type: - type: string - const: string - title: Type - default: string - type: object - title: StringType - description: Parameter type for string values. - SystemMessage: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - type: object - required: - - content - title: SystemMessage - description: A system message providing instructions or context to the model. - TextContentItem: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: TextContentItem - description: A text content item - ToolDef: - properties: - toolgroup_id: - anyOf: - - type: string - - type: 'null' - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - input_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - output_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - name - title: ToolDef - description: Tool definition used in runtime contexts. - ToolGroup: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: tool_group - title: Type - default: tool_group - mcp_endpoint: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - args: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: ToolGroup - description: A group of related tools managed together. - ToolInvocationResult: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - - type: 'null' - title: string | list[ImageContentItem-Output | TextContentItem] - error_message: - anyOf: - - type: string - - type: 'null' - error_code: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: ToolInvocationResult - description: Result of a tool invocation. - TopKSamplingStrategy: - properties: - type: - type: string - const: top_k - title: Type - default: top_k - top_k: - type: integer - minimum: 1.0 - title: Top K - type: object - required: - - top_k - title: TopKSamplingStrategy - description: Top-k sampling strategy that restricts sampling to the k most likely tokens. - TopPSamplingStrategy: - properties: - type: - type: string - const: top_p - title: Type - default: top_p - temperature: - anyOf: - - type: number - minimum: 0.0 - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - default: 0.95 - type: object - required: - - temperature - title: TopPSamplingStrategy - description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. - TrainingConfig: - properties: - n_epochs: - type: integer - title: N Epochs - max_steps_per_epoch: - type: integer - title: Max Steps Per Epoch - default: 1 - gradient_accumulation_steps: - type: integer - title: Gradient Accumulation Steps - default: 1 - max_validation_steps: - anyOf: - - type: integer - - type: 'null' - default: 1 - data_config: - anyOf: - - $ref: '#/components/schemas/DataConfig' - title: DataConfig - - type: 'null' - title: DataConfig - optimizer_config: - anyOf: - - $ref: '#/components/schemas/OptimizerConfig' - title: OptimizerConfig - - type: 'null' - title: OptimizerConfig - efficiency_config: - anyOf: - - $ref: '#/components/schemas/EfficiencyConfig' - title: EfficiencyConfig - - type: 'null' - title: EfficiencyConfig - dtype: - anyOf: - - type: string - - type: 'null' - default: bf16 - type: object - required: - - n_epochs - title: TrainingConfig - description: Comprehensive configuration for the training process. - URIDataSource: - properties: - type: - type: string - const: uri - title: Type - default: uri - uri: - type: string - title: Uri - type: object - required: - - uri - title: URIDataSource - description: A dataset that can be obtained from a URI. - URL: - properties: - uri: - type: string - title: Uri - type: object - required: - - uri - title: URL - description: A URL reference to external content. - UnionType: - properties: - type: - type: string - const: union - title: Type - default: union - type: object - title: UnionType - description: Parameter type for union values. - VectorStoreChunkingStrategyAuto: - properties: - type: - type: string - const: auto - title: Type - default: auto - type: object - title: VectorStoreChunkingStrategyAuto - description: Automatic chunking strategy for vector store files. - VectorStoreChunkingStrategyStatic: - properties: - type: - type: string - const: static - title: Type - default: static - static: - $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - type: object - required: - - static - title: VectorStoreChunkingStrategyStatic - description: Static chunking strategy with configurable parameters. - VectorStoreChunkingStrategyStaticConfig: - properties: - chunk_overlap_tokens: - type: integer - title: Chunk Overlap Tokens - default: 400 - max_chunk_size_tokens: - type: integer - maximum: 4096.0 - minimum: 100.0 - title: Max Chunk Size Tokens - default: 800 - type: object - title: VectorStoreChunkingStrategyStaticConfig - description: Configuration for static chunking strategy. - VectorStoreContent: - properties: - type: - type: string - const: text - title: Type - text: - type: string - title: Text - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - type - - text - title: VectorStoreContent - description: Content item from a vector store file or search result. - VectorStoreDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreDeleteResponse - description: Response from deleting a vector store. - VectorStoreFileBatchObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file_batch - created_at: - type: integer - title: Created At - vector_store_id: - type: string - title: Vector Store Id - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - type: object - required: - - id - - created_at - - vector_store_id - - status - - file_counts - title: VectorStoreFileBatchObject - description: OpenAI Vector Store File Batch object. - VectorStoreFileContentResponse: - properties: - object: - type: string - const: vector_store.file_content.page - title: Object - default: vector_store.file_content.page - data: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - title: VectorStoreFileContentResponse - description: Represents the parsed content of a vector store file. - VectorStoreFileCounts: - properties: - completed: - type: integer - title: Completed - cancelled: - type: integer - title: Cancelled - failed: - type: integer - title: Failed - in_progress: - type: integer - title: In Progress - total: - type: integer - title: Total - type: object - required: - - completed - - cancelled - - failed - - in_progress - - total - title: VectorStoreFileCounts - description: File processing status counts for a vector store. - VectorStoreFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreFileDeleteResponse - description: Response from deleting a vector store file. - VectorStoreFileLastError: - properties: - code: - title: Code - type: string - enum: - - server_error - - rate_limit_exceeded - default: server_error - message: - type: string - title: Message - type: object - required: - - code - - message - title: VectorStoreFileLastError - description: Error information for failed vector store file processing. - VectorStoreFileObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file - attributes: - additionalProperties: true - type: object - title: Attributes - chunking_strategy: - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - created_at: - type: integer - title: Created At - last_error: - anyOf: - - $ref: '#/components/schemas/VectorStoreFileLastError' - title: VectorStoreFileLastError - - type: 'null' - title: VectorStoreFileLastError - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - vector_store_id: - type: string - title: Vector Store Id - type: object - required: - - id - - chunking_strategy - - created_at - - status - - vector_store_id - title: VectorStoreFileObject - description: OpenAI Vector Store File object. - VectorStoreFilesListInBatchResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreFilesListInBatchResponse - description: Response from listing files in a vector store file batch. - VectorStoreListFilesResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListFilesResponse - description: Response from listing files in a vector store. - VectorStoreListResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListResponse - description: Response from listing vector stores. - VectorStoreObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store - created_at: - type: integer - title: Created At - name: - anyOf: - - type: string - - type: 'null' - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - status: - type: string - title: Status - default: completed - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - last_active_at: - anyOf: - - type: integer - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - id - - created_at - - file_counts - title: VectorStoreObject - description: OpenAI Vector Store object. - VectorStoreSearchResponse-Output: - properties: - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - attributes: - anyOf: - - additionalProperties: - anyOf: - - type: string - - type: number - - type: boolean - title: string | number | boolean - type: object - - type: 'null' - content: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Content - type: object - required: - - file_id - - filename - - score - - content - title: VectorStoreSearchResponse - description: Response from searching a vector store. - VectorStoreSearchResponsePage: - properties: - object: - type: string - title: Object - default: vector_store.search_results.page - search_query: - items: - type: string - type: array - title: Search Query - data: - items: - $ref: '#/components/schemas/VectorStoreSearchResponse-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - search_query - - data - title: VectorStoreSearchResponsePage - description: Paginated response from searching a vector store. - VersionInfo: - properties: - version: - type: string - title: Version - type: object - required: - - version - title: VersionInfo - description: Version information for the service. - ViolationLevel: - type: string - enum: - - info - - warn - - error - title: ViolationLevel - description: Severity level of a safety violation. - _URLOrData: - properties: - url: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - data: - anyOf: - - type: string - - type: 'null' - contentEncoding: base64 - type: object - title: _URLOrData - description: A URL or a base64 encoded string - _batches_Request: - properties: - input_file_id: - type: string - title: Input File Id - endpoint: - type: string - title: Endpoint - completion_window: - type: string - const: 24h - title: Completion Window - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - idempotency_key: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_file_id - - endpoint - - completion_window - title: _batches_Request - _conversations_Request: - properties: - items: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - type: object - title: _conversations_Request - _conversations_conversation_id_Request: - properties: - metadata: - additionalProperties: - type: string - type: object - title: Metadata - type: object - required: - - metadata - title: _conversations_conversation_id_Request - _conversations_conversation_id_items_Request: - properties: - items: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - title: Items - type: object - required: - - items - title: _conversations_conversation_id_items_Request - _eval_benchmarks_benchmark_id_evaluations_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - benchmark_config: - $ref: '#/components/schemas/BenchmarkConfig' - type: object - required: - - input_rows - - scoring_functions - - benchmark_config - title: _eval_benchmarks_benchmark_id_evaluations_Request - _inference_rerank_Request: - properties: - model: - type: string - title: Model - query: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - items: - items: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - type: array - title: Items - max_num_results: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - model - - query - - items - title: _inference_rerank_Request - _moderations_Request: - properties: - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - model: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input - title: _moderations_Request - _post_training_preference_optimize_Request: - properties: - job_uuid: - type: string - title: Job Uuid - finetuned_model: - type: string - title: Finetuned Model - algorithm_config: - $ref: '#/components/schemas/DPOAlignmentConfig' - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - type: object - required: - - job_uuid - - finetuned_model - - algorithm_config - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_preference_optimize_Request - _post_training_supervised_fine_tune_Request: - properties: - job_uuid: - type: string - title: Job Uuid - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - model: - anyOf: - - type: string - - type: 'null' - description: Model descriptor for training if not in provider config` - checkpoint_dir: - anyOf: - - type: string - - type: 'null' - algorithm_config: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LoraFinetuningConfig' - title: LoraFinetuningConfig - - $ref: '#/components/schemas/QATFinetuningConfig' - title: QATFinetuningConfig - discriminator: - propertyName: type - mapping: - LoRA: '#/components/schemas/LoraFinetuningConfig' - QAT: '#/components/schemas/QATFinetuningConfig' - title: LoraFinetuningConfig | QATFinetuningConfig - - type: 'null' - title: Algorithm Config - type: object - required: - - job_uuid - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_supervised_fine_tune_Request - _prompts_Request: - properties: - prompt: - type: string - title: Prompt - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - required: - - prompt - title: _prompts_Request - _prompts_prompt_id_Request: - properties: - prompt: - type: string - title: Prompt - version: - type: integer - title: Version - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - set_as_default: - type: boolean - title: Set As Default - default: true - type: object - required: - - prompt - - version - title: _prompts_prompt_id_Request - _prompts_prompt_id_set_default_version_Request: - properties: - version: - type: integer - title: Version - type: object - required: - - version - title: _prompts_prompt_id_set_default_version_Request - _responses_Request: - properties: - input: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIResponseMessageInputUnion' - type: array - title: list[OpenAIResponseMessageInputUnion] - title: string | list[OpenAIResponseMessageInputUnion] - model: - type: string - title: Model - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - instructions: - anyOf: - - type: string - - type: 'null' - previous_response_id: - anyOf: - - type: string - - type: 'null' - conversation: - anyOf: - - type: string - - type: 'null' - store: - anyOf: - - type: boolean - - type: 'null' - default: true - stream: - anyOf: - - type: boolean - - type: 'null' - default: false - temperature: - anyOf: - - type: number - - type: 'null' - text: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseText' - title: OpenAIResponseText - - type: 'null' - title: OpenAIResponseText - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' - title: OpenAIResponseInputToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseInputToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - include: - anyOf: - - items: - type: string - type: array - - type: 'null' - max_infer_iters: - anyOf: - - type: integer - - type: 'null' - default: 10 - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - input - - model - title: _responses_Request - _scoring_score_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - type: object - required: - - input_rows - - scoring_functions - title: _scoring_score_Request - _scoring_score_batch_Request: - properties: - dataset_id: - type: string - title: Dataset Id - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - save_results_dataset: - type: boolean - title: Save Results Dataset - default: false - type: object - required: - - dataset_id - - scoring_functions - title: _scoring_score_batch_Request - _tool_runtime_invoke_Request: - properties: - tool_name: - type: string - title: Tool Name - kwargs: - additionalProperties: true - type: object - title: Kwargs - type: object - required: - - tool_name - - kwargs - title: _tool_runtime_invoke_Request - _vector_io_query_Request: - properties: - vector_store_id: - type: string - title: Vector Store Id - query: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - vector_store_id - - query - title: _vector_io_query_Request - _vector_stores_vector_store_id_Request: - properties: - name: - anyOf: - - type: string - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: _vector_stores_vector_store_id_Request - _vector_stores_vector_store_id_files_Request: - properties: - file_id: - type: string - title: File Id - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - type: object - required: - - file_id - title: _vector_stores_vector_store_id_files_Request - _vector_stores_vector_store_id_files_file_id_Request: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - type: object - required: - - attributes - title: _vector_stores_vector_store_id_files_file_id_Request - _vector_stores_vector_store_id_search_Request: - properties: - query: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - rewrite_query: - anyOf: - - type: boolean - - type: 'null' - default: false - search_mode: - anyOf: - - type: string - - type: 'null' - default: vector - type: object - required: - - query - title: _vector_stores_vector_store_id_search_Request - Error: - description: Error response from the API. Roughly follows RFC 7807. - properties: - status: - title: Status - type: integer - title: - title: Title - type: string - detail: - title: Detail - type: string - instance: - anyOf: - - type: string - - type: 'null' - nullable: true - required: - - status - - title - - detail - title: Error - type: object ImageContentItem: description: A image content item properties: @@ -11071,6 +2653,49 @@ components: - image title: ImageContentItem type: object + TextContentItem: + description: A text content item + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextContentItem + type: object + URL: + description: A URL reference to external content. + properties: + uri: + title: Uri + type: string + required: + - uri + title: URL + type: object + _URLOrData: + description: A URL or a base64 encoded string + properties: + url: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + data: + anyOf: + - type: string + - type: 'null' + contentEncoding: base64 + nullable: true + title: _URLOrData + type: object InterleavedContentItem: discriminator: mapping: @@ -11112,110 +2737,54 @@ components: type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] - BuiltinTool: - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - title: BuiltinTool - type: string - ImageDelta: - description: An image content delta for streaming responses. + GreedySamplingStrategy: + description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: - const: image - default: image + const: greedy + default: greedy title: Type type: string - image: - format: binary - title: Image - type: string - required: - - image - title: ImageDelta + title: GreedySamplingStrategy type: object - TextDelta: - description: A text content delta for streaming responses. + TopKSamplingStrategy: + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: - const: text - default: text + const: top_k + default: top_k title: Type type: string - text: - title: Text - type: string + top_k: + minimum: 1 + title: Top K + type: integer required: - - text - title: TextDelta + - top_k + title: TopKSamplingStrategy type: object - ToolCall: + TopPSamplingStrategy: + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: - call_id: - title: Call Id + type: + const: top_p + default: top_p + title: Type type: string - tool_name: + temperature: anyOf: - - $ref: '#/components/schemas/BuiltinTool' - title: BuiltinTool - - type: string - title: BuiltinTool | string - arguments: - title: Arguments - type: string - required: - - call_id - - tool_name - - arguments - title: ToolCall - type: object - ToolCallDelta: - description: A tool call content delta for streaming responses. - properties: - type: - const: tool_call - default: tool_call - title: Type - type: string - tool_call: + - type: number + minimum: 0.0 + - type: 'null' + top_p: anyOf: - - type: string - - $ref: '#/components/schemas/ToolCall' - title: ToolCall - title: string | ToolCall - parse_status: - $ref: '#/components/schemas/ToolCallParseStatus' + - type: number + - type: 'null' + default: 0.95 required: - - tool_call - - parse_status - title: ToolCallDelta + - temperature + title: TopPSamplingStrategy type: object - ToolCallParseStatus: - description: Status of tool call parsing during streaming. - enum: - - started - - in_progress - - failed - - succeeded - title: ToolCallParseStatus - type: string - ContentDelta: - discriminator: - mapping: - image: '#/components/schemas/ImageDelta' - text: '#/components/schemas/TextDelta' - tool_call: '#/components/schemas/ToolCallDelta' - propertyName: type - oneOf: - - $ref: '#/components/schemas/TextDelta' - title: TextDelta - - $ref: '#/components/schemas/ImageDelta' - title: ImageDelta - - $ref: '#/components/schemas/ToolCallDelta' - title: ToolCallDelta - title: TextDelta | ImageDelta | ToolCallDelta SamplingStrategy: discriminator: mapping: @@ -11275,6 +2844,82 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat + OpenAIChatCompletionContentPartImageParam: + description: Image content part for OpenAI-compatible chat completion messages. + properties: + type: + const: image_url + default: image_url + title: Type + type: string + image_url: + $ref: '#/components/schemas/OpenAIImageURL' + required: + - image_url + title: OpenAIChatCompletionContentPartImageParam + type: object + OpenAIChatCompletionContentPartTextParam: + description: Text content part for OpenAI-compatible chat completion messages. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: OpenAIChatCompletionContentPartTextParam + type: object + OpenAIFile: + properties: + type: + const: file + default: file + title: Type + type: string + file: + $ref: '#/components/schemas/OpenAIFileFile' + required: + - file + title: OpenAIFile + type: object + OpenAIFileFile: + properties: + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIFileFile + type: object + OpenAIImageURL: + description: Image URL specification for OpenAI-compatible chat completion messages. + properties: + url: + title: Url + type: string + detail: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - url + title: OpenAIImageURL + type: object OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -11322,6 +2967,122 @@ components: nullable: true title: OpenAIAssistantMessageParam type: object + OpenAIChatCompletionToolCall: + description: Tool call specification for OpenAI-compatible chat completion responses. + properties: + index: + anyOf: + - type: integer + - type: 'null' + nullable: true + id: + anyOf: + - type: string + - type: 'null' + nullable: true + type: + const: function + default: function + title: Type + type: string + function: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' + title: OpenAIChatCompletionToolCallFunction + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + title: OpenAIChatCompletionToolCall + type: object + OpenAIChatCompletionToolCallFunction: + description: Function call details for OpenAI-compatible tool calls. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + arguments: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + type: object + OpenAIDeveloperMessageParam: + description: A message from the developer in an OpenAI-compatible chat completion request. + properties: + role: + const: developer + default: developer + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAIDeveloperMessageParam + type: object + OpenAISystemMessageParam: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAISystemMessageParam + type: object + OpenAIToolMessageParam: + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. + properties: + role: + const: tool + default: tool + title: Role + type: string + tool_call_id: + title: Tool Call Id + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + required: + - tool_call_id + - content + title: OpenAIToolMessageParam + type: object OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -11381,6 +3142,61 @@ components: - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) + OpenAIJSONSchema: + description: JSON schema specification for OpenAI-compatible structured response format. + properties: + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + title: OpenAIJSONSchema + type: object + OpenAIResponseFormatJSONObject: + description: JSON object response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_object + default: json_object + title: Type + type: string + title: OpenAIResponseFormatJSONObject + type: object + OpenAIResponseFormatJSONSchema: + description: JSON schema response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_schema + default: json_schema + title: Type + type: string + json_schema: + $ref: '#/components/schemas/OpenAIJSONSchema' + required: + - json_schema + title: OpenAIResponseFormatJSONSchema + type: object + OpenAIResponseFormatText: + description: Text response format for OpenAI-compatible chat completion requests. + properties: + type: + const: text + default: text + title: Type + type: string + title: OpenAIResponseFormatText + type: object OpenAIResponseFormatParam: discriminator: mapping: @@ -11396,6 +3212,45 @@ components: - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + VectorStoreChunkingStrategyAuto: + description: Automatic chunking strategy for vector store files. + properties: + type: + const: auto + default: auto + title: Type + type: string + title: VectorStoreChunkingStrategyAuto + type: object + VectorStoreChunkingStrategyStatic: + description: Static chunking strategy with configurable parameters. + properties: + type: + const: static + default: static + title: Type + type: string + static: + $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + required: + - static + title: VectorStoreChunkingStrategyStatic + type: object + VectorStoreChunkingStrategyStaticConfig: + description: Configuration for static chunking strategy. + properties: + chunk_overlap_tokens: + default: 400 + title: Chunk Overlap Tokens + type: integer + max_chunk_size_tokens: + default: 800 + maximum: 4096 + minimum: 100 + title: Max Chunk Size Tokens + type: integer + title: VectorStoreChunkingStrategyStaticConfig + type: object VectorStoreChunkingStrategy: discriminator: mapping: @@ -11416,6 +3271,79 @@ components: - cancelled - failed default: completed + OpenAIResponseInputMessageContentFile: + description: File content for input messages in OpenAI response format. + properties: + type: + const: input_file + default: input_file + title: Type + type: string + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + file_url: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentFile + type: object + OpenAIResponseInputMessageContentImage: + description: Image content for input messages in OpenAI response format. + properties: + detail: + default: auto + title: Detail + type: string + enum: + - low + - high + - auto + type: + const: input_image + default: input_image + title: Type + type: string + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + image_url: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentImage + type: object + OpenAIResponseInputMessageContentText: + description: Text content for input messages in OpenAI response format. + properties: + text: + title: Text + type: string + type: + const: input_text + default: input_text + title: Type + type: string + required: + - text + title: OpenAIResponseInputMessageContentText + type: object OpenAIResponseInputMessageContent: discriminator: mapping: @@ -11431,6 +3359,104 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + OpenAIResponseAnnotationCitation: + description: URL citation annotation for referencing external web resources. + properties: + type: + const: url_citation + default: url_citation + title: Type + type: string + end_index: + title: End Index + type: integer + start_index: + title: Start Index + type: integer + title: + title: Title + type: string + url: + title: Url + type: string + required: + - end_index + - start_index + - title + - url + title: OpenAIResponseAnnotationCitation + type: object + OpenAIResponseAnnotationContainerFileCitation: + properties: + type: + const: container_file_citation + default: container_file_citation + title: Type + type: string + container_id: + title: Container Id + type: string + end_index: + title: End Index + type: integer + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + start_index: + title: Start Index + type: integer + required: + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation + type: object + OpenAIResponseAnnotationFileCitation: + description: File citation annotation for referencing specific files in response content. + properties: + type: + const: file_citation + default: file_citation + title: Type + type: string + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + index: + title: Index + type: integer + required: + - file_id + - filename + - index + title: OpenAIResponseAnnotationFileCitation + type: object + OpenAIResponseAnnotationFilePath: + properties: + type: + const: file_path + default: file_path + title: Type + type: string + file_id: + title: File Id + type: string + index: + title: Index + type: integer + required: + - file_id + - index + title: OpenAIResponseAnnotationFilePath + type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -11449,6 +3475,56 @@ components: - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + OpenAIResponseContentPartRefusal: + description: Refusal content within a streamed response part. + properties: + type: + const: refusal + default: refusal + title: Type + type: string + refusal: + title: Refusal + type: string + required: + - refusal + title: OpenAIResponseContentPartRefusal + type: object + OpenAIResponseOutputMessageContentOutputText: + properties: + text: + title: Text + type: string + type: + const: output_text + default: output_text + title: Type + type: string + annotations: + items: + discriminator: + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + title: OpenAIResponseAnnotationFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + title: OpenAIResponseAnnotationCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + title: OpenAIResponseAnnotationContainerFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + title: OpenAIResponseAnnotationFilePath + title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + title: Annotations + type: array + required: + - text + title: OpenAIResponseOutputMessageContentOutputText + type: object OpenAIResponseOutputMessageContent: discriminator: mapping: @@ -11461,6 +3537,53 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal + MCPListToolsTool: + description: Tool definition returned by MCP list tools operation. + properties: + input_schema: + additionalProperties: true + title: Input Schema + type: object + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - input_schema + - name + title: MCPListToolsTool + type: object + OpenAIResponseMCPApprovalRequest: + description: A request for human approval of a tool invocation. + properties: + arguments: + title: Arguments + type: string + id: + title: Id + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + type: + const: mcp_approval_request + default: mcp_approval_request + title: Type + type: string + required: + - arguments + - id + - name + - server_label + title: OpenAIResponseMCPApprovalRequest + type: object OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -11532,6 +3655,179 @@ components: - role title: OpenAIResponseMessage type: object + OpenAIResponseOutputMessageFileSearchToolCall: + description: File search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + queries: + items: + type: string + title: Queries + type: array + status: + title: Status + type: string + type: + const: file_search_call + default: file_search_call + title: Type + type: string + results: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' + type: array + - type: 'null' + nullable: true + required: + - id + - queries + - status + title: OpenAIResponseOutputMessageFileSearchToolCall + type: object + OpenAIResponseOutputMessageFileSearchToolCallResults: + description: Search results returned by the file search operation. + properties: + attributes: + additionalProperties: true + title: Attributes + type: object + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + score: + title: Score + type: number + text: + title: Text + type: string + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + type: object + OpenAIResponseOutputMessageFunctionToolCall: + description: Function tool call output message for OpenAI responses. + properties: + call_id: + title: Call Id + type: string + name: + title: Name + type: string + arguments: + title: Arguments + type: string + type: + const: function_call + default: function_call + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - name + - arguments + title: OpenAIResponseOutputMessageFunctionToolCall + type: object + OpenAIResponseOutputMessageMCPCall: + description: Model Context Protocol (MCP) call output message for OpenAI responses. + properties: + id: + title: Id + type: string + type: + const: mcp_call + default: mcp_call + title: Type + type: string + arguments: + title: Arguments + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + error: + anyOf: + - type: string + - type: 'null' + nullable: true + output: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + - arguments + - name + - server_label + title: OpenAIResponseOutputMessageMCPCall + type: object + OpenAIResponseOutputMessageMCPListTools: + description: MCP list tools output message containing available tools from an MCP server. + properties: + id: + title: Id + type: string + type: + const: mcp_list_tools + default: mcp_list_tools + title: Type + type: string + server_label: + title: Server Label + type: string + tools: + items: + $ref: '#/components/schemas/MCPListToolsTool' + title: Tools + type: array + required: + - id + - server_label + - tools + title: OpenAIResponseOutputMessageMCPListTools + type: object + OpenAIResponseOutputMessageWebSearchToolCall: + description: Web search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + status: + title: Status + type: string + type: + const: web_search_call + default: web_search_call + title: Type + type: string + required: + - id + - status + title: OpenAIResponseOutputMessageWebSearchToolCall + type: object OpenAIResponseOutput: discriminator: mapping: @@ -11559,6 +3855,186 @@ components: - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) + AllowedToolsFilter: + description: Filter configuration for restricting which MCP tools can be used. + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: AllowedToolsFilter + type: object + ApprovalFilter: + description: Filter configuration for MCP tool approval requirements. + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: ApprovalFilter + type: object + OpenAIResponseInputToolFileSearch: + description: File search tool configuration for OpenAI response inputs. + properties: + type: + const: file_search + default: file_search + title: Type + type: string + vector_store_ids: + items: + type: string + title: Vector Store Ids + type: array + filters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + max_num_results: + anyOf: + - maximum: 50 + minimum: 1 + type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + nullable: true + title: SearchRankingOptions + required: + - vector_store_ids + title: OpenAIResponseInputToolFileSearch + type: object + OpenAIResponseInputToolFunction: + description: Function tool configuration for OpenAI response inputs. + properties: + type: + const: function + default: function + title: Type + type: string + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + parameters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + nullable: true + required: + - name + - parameters + title: OpenAIResponseInputToolFunction + type: object + OpenAIResponseInputToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + server_url: + title: Server Url + type: string + headers: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + require_approval: + anyOf: + - const: always + type: string + - const: never + type: string + - $ref: '#/components/schemas/ApprovalFilter' + title: ApprovalFilter + default: never + title: string | ApprovalFilter + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + - server_url + title: OpenAIResponseInputToolMCP + type: object + OpenAIResponseInputToolWebSearch: + description: Web search tool configuration for OpenAI response inputs. + properties: + type: + default: web_search + title: Type + type: string + enum: + - web_search + - web_search_preview + - web_search_preview_2025_03_11 + - web_search_2025_08_26 + search_context_size: + anyOf: + - pattern: ^low|medium|high$ + type: string + - type: 'null' + default: medium + title: OpenAIResponseInputToolWebSearch + type: object + SearchRankingOptions: + description: Options for ranking and filtering search results. + properties: + ranker: + anyOf: + - type: string + - type: 'null' + nullable: true + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + title: SearchRankingOptions + type: object OpenAIResponseInputTool: discriminator: mapping: @@ -11580,6 +4056,32 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) + OpenAIResponseToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + title: OpenAIResponseToolMCP + type: object OpenAIResponseTool: discriminator: mapping: @@ -11690,6 +4192,164 @@ components: - text title: OpenAIResponseContentPartReasoningSummary type: object + OpenAIResponseError: + description: Error details for failed OpenAI response requests. + properties: + code: + title: Code + type: string + message: + title: Message + type: string + required: + - code + - message + title: OpenAIResponseError + type: object + OpenAIResponseObject: + description: Complete OpenAI response object containing generation results and metadata. + properties: + created_at: + title: Created At + type: integer + error: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseError' + title: OpenAIResponseError + - type: 'null' + nullable: true + title: OpenAIResponseError + id: + title: Id + type: string + model: + title: Model + type: string + object: + const: response + default: response + title: Object + type: string + output: + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + title: Output + type: array + parallel_tool_calls: + default: false + title: Parallel Tool Calls + type: boolean + previous_response_id: + anyOf: + - type: string + - type: 'null' + nullable: true + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + nullable: true + title: OpenAIResponsePrompt + status: + title: Status + type: string + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + text: + $ref: '#/components/schemas/OpenAIResponseText' + default: + format: + type: text + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + tools: + anyOf: + - items: + discriminator: + mapping: + file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' + function: '#/components/schemas/OpenAIResponseInputToolFunction' + mcp: '#/components/schemas/OpenAIResponseToolMCP' + web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + title: OpenAIResponseInputToolWebSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + title: OpenAIResponseInputToolFileSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + title: OpenAIResponseInputToolFunction + - $ref: '#/components/schemas/OpenAIResponseToolMCP' + title: OpenAIResponseToolMCP + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + nullable: true + truncation: + anyOf: + - type: string + - type: 'null' + nullable: true + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsage' + title: OpenAIResponseUsage + - type: 'null' + nullable: true + title: OpenAIResponseUsage + instructions: + anyOf: + - type: string + - type: 'null' + nullable: true + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + nullable: true + required: + - created_at + - id + - model + - output + - status + title: OpenAIResponseObject + type: object OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: @@ -12664,6 +5324,135 @@ components: - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object + OpenAIResponsePrompt: + description: OpenAI compatible Prompt object that is used in OpenAI responses. + properties: + id: + title: Id + type: string + variables: + anyOf: + - additionalProperties: + discriminator: + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: object + - type: 'null' + nullable: true + version: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + title: OpenAIResponsePrompt + type: object + OpenAIResponseText: + description: Text response configuration for OpenAI responses. + properties: + format: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseTextFormat' + title: OpenAIResponseTextFormat + - type: 'null' + nullable: true + title: OpenAIResponseTextFormat + title: OpenAIResponseText + type: object + OpenAIResponseTextFormat: + description: Configuration for Responses API text format. + properties: + type: + title: Type + type: string + enum: + - text + - json_schema + - json_object + default: text + name: + anyOf: + - type: string + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + title: OpenAIResponseTextFormat + type: object + OpenAIResponseUsage: + description: Usage information for OpenAI response. + properties: + input_tokens: + title: Input Tokens + type: integer + output_tokens: + title: Output Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + input_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' + title: OpenAIResponseUsageInputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + output_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' + title: OpenAIResponseUsageOutputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + required: + - input_tokens + - output_tokens + - total_tokens + title: OpenAIResponseUsage + type: object + OpenAIResponseUsageInputTokensDetails: + description: Token details for input tokens in OpenAI response usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + type: object + OpenAIResponseUsageOutputTokensDetails: + description: Token details for output tokens in OpenAI response usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + type: object OpenAIResponseObjectStream: discriminator: mapping: @@ -12778,6 +5567,64 @@ components: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) + OpenAIResponseInputFunctionToolCallOutput: + description: This represents the output of a function call that gets passed back to the model. + properties: + call_id: + title: Call Id + type: string + output: + title: Output + type: string + type: + const: function_call_output + default: function_call_output + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - output + title: OpenAIResponseInputFunctionToolCallOutput + type: object + OpenAIResponseMCPApprovalResponse: + description: A response to an MCP approval request. + properties: + approval_request_id: + title: Approval Request Id + type: string + approve: + title: Approve + type: boolean + type: + const: mcp_approval_response + default: mcp_approval_response + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + reason: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - approval_request_id + - approve + title: OpenAIResponseMCPApprovalResponse + type: object OpenAIResponseInput: anyOf: - discriminator: @@ -12813,51 +5660,96 @@ components: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage - ConversationItem: - discriminator: - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - propertyName: type - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - title: OpenAIResponseMessage - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - DataSource: - discriminator: - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - propertyName: type - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource + ArrayType: + description: Parameter type for array values. + properties: + type: + const: array + default: array + title: Type + type: string + title: ArrayType + type: object + BooleanType: + description: Parameter type for boolean values. + properties: + type: + const: boolean + default: boolean + title: Type + type: string + title: BooleanType + type: object + ChatCompletionInputType: + description: Parameter type for chat completion input. + properties: + type: + const: chat_completion_input + default: chat_completion_input + title: Type + type: string + title: ChatCompletionInputType + type: object + CompletionInputType: + description: Parameter type for completion input. + properties: + type: + const: completion_input + default: completion_input + title: Type + type: string + title: CompletionInputType + type: object + JsonType: + description: Parameter type for JSON values. + properties: + type: + const: json + default: json + title: Type + type: string + title: JsonType + type: object + NumberType: + description: Parameter type for numeric values. + properties: + type: + const: number + default: number + title: Type + type: string + title: NumberType + type: object + ObjectType: + description: Parameter type for object values. + properties: + type: + const: object + default: object + title: Type + type: string + title: ObjectType + type: object + StringType: + description: Parameter type for string values. + properties: + type: + const: string + default: string + title: Type + type: string + title: StringType + type: object + UnionType: + description: Parameter type for union values. + properties: + type: + const: union + default: union + title: Type + type: string + title: UnionType + type: object ParamType: discriminator: mapping: @@ -12891,6 +5783,164 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + ConversationItem: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + RowsDataSource: + description: A dataset stored in rows. + properties: + type: + const: rows + default: rows + title: Type + type: string + rows: + items: + additionalProperties: true + type: object + title: Rows + type: array + required: + - rows + title: RowsDataSource + type: object + URIDataSource: + description: A dataset that can be obtained from a URI. + properties: + type: + const: uri + default: uri + title: Type + type: string + uri: + title: Uri + type: string + required: + - uri + title: URIDataSource + type: object + DataSource: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + AggregationFunctionType: + description: Types of aggregation functions for scoring results. + enum: + - average + - weighted_average + - median + - categorical_count + - accuracy + title: AggregationFunctionType + type: string + BasicScoringFnParams: + description: Parameters for basic scoring function configuration. + properties: + type: + const: basic + default: basic + title: Type + type: string + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: BasicScoringFnParams + type: object + LLMAsJudgeScoringFnParams: + description: Parameters for LLM-as-judge scoring function configuration. + properties: + type: + const: llm_as_judge + default: llm_as_judge + title: Type + type: string + judge_model: + title: Judge Model + type: string + prompt_template: + anyOf: + - type: string + - type: 'null' + nullable: true + judge_score_regexes: + description: Regexes to extract the answer from generated response + items: + type: string + title: Judge Score Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + required: + - judge_model + title: LLMAsJudgeScoringFnParams + type: object + RegexParserScoringFnParams: + description: Parameters for regex parser scoring function configuration. + properties: + type: + const: regex_parser + default: regex_parser + title: Type + type: string + parsing_regexes: + description: Regex to extract the answer from generated response + items: + type: string + title: Parsing Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: RegexParserScoringFnParams + type: object ScoringFnParams: discriminator: mapping: @@ -12906,6 +5956,68 @@ components: - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + LoraFinetuningConfig: + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. + properties: + type: + const: LoRA + default: LoRA + title: Type + type: string + lora_attn_modules: + items: + type: string + title: Lora Attn Modules + type: array + apply_lora_to_mlp: + title: Apply Lora To Mlp + type: boolean + apply_lora_to_output: + title: Apply Lora To Output + type: boolean + rank: + title: Rank + type: integer + alpha: + title: Alpha + type: integer + use_dora: + anyOf: + - type: boolean + - type: 'null' + default: false + quantize_base: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + title: LoraFinetuningConfig + type: object + QATFinetuningConfig: + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. + properties: + type: + const: QAT + default: QAT + title: Type + type: string + quantizer_name: + title: Quantizer Name + type: string + group_size: + title: Group Size + type: integer + required: + - quantizer_name + - group_size + title: QATFinetuningConfig + type: object AlgorithmConfig: discriminator: mapping: @@ -13139,15 +6251,55 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - ResponseGuardrailSpec: - description: Specification for a guardrail to apply during response generation. + ListOpenAIResponseInputItem: + description: List container for OpenAI response input items. properties: - type: - title: Type + data: + items: + anyOf: + - discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage + title: Data + type: array + object: + const: list + default: list + title: Object type: string required: - - type - title: ResponseGuardrailSpec + - data + title: ListOpenAIResponseInputItem type: object OpenAIResponseObjectWithInput: description: OpenAI response object extended with input context information. @@ -13332,6 +6484,426 @@ components: - input title: OpenAIResponseObjectWithInput type: object + ListOpenAIResponseObject: + description: Paginated list of OpenAI response objects with navigation metadata. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIResponseObjectWithInput' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIResponseObject + type: object + OpenAIDeleteResponseObject: + description: Response object confirming deletion of an OpenAI response. + properties: + id: + title: Id + type: string + object: + const: response + default: response + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: OpenAIDeleteResponseObject + type: object + ResponseGuardrailSpec: + description: Specification for a guardrail to apply during response generation. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + Batch: + additionalProperties: true + properties: + id: + title: Id + type: string + completion_window: + title: Completion Window + type: string + created_at: + title: Created At + type: integer + endpoint: + title: Endpoint + type: string + input_file_id: + title: Input File Id + type: string + object: + const: batch + title: Object + type: string + status: + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + title: Status + type: string + cancelled_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + cancelling_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + completed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + error_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + errors: + anyOf: + - $ref: '#/components/schemas/Errors' + title: Errors + - type: 'null' + nullable: true + title: Errors + expired_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + failed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + finalizing_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + in_progress_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + nullable: true + model: + anyOf: + - type: string + - type: 'null' + nullable: true + output_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + request_counts: + anyOf: + - $ref: '#/components/schemas/BatchRequestCounts' + title: BatchRequestCounts + - type: 'null' + nullable: true + title: BatchRequestCounts + usage: + anyOf: + - $ref: '#/components/schemas/BatchUsage' + title: BatchUsage + - type: 'null' + nullable: true + title: BatchUsage + required: + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status + title: Batch + type: object + BatchError: + additionalProperties: true + properties: + code: + anyOf: + - type: string + - type: 'null' + nullable: true + line: + anyOf: + - type: integer + - type: 'null' + nullable: true + message: + anyOf: + - type: string + - type: 'null' + nullable: true + param: + anyOf: + - type: string + - type: 'null' + nullable: true + title: BatchError + type: object + BatchRequestCounts: + additionalProperties: true + properties: + completed: + title: Completed + type: integer + failed: + title: Failed + type: integer + total: + title: Total + type: integer + required: + - completed + - failed + - total + title: BatchRequestCounts + type: object + BatchUsage: + additionalProperties: true + properties: + input_tokens: + title: Input Tokens + type: integer + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + title: Output Tokens + type: integer + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + title: Total Tokens + type: integer + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + type: object + Errors: + additionalProperties: true + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + nullable: true + object: + anyOf: + - type: string + - type: 'null' + nullable: true + title: Errors + type: object + InputTokensDetails: + additionalProperties: true + properties: + cached_tokens: + title: Cached Tokens + type: integer + required: + - cached_tokens + title: InputTokensDetails + type: object + OutputTokensDetails: + additionalProperties: true + properties: + reasoning_tokens: + title: Reasoning Tokens + type: integer + required: + - reasoning_tokens + title: OutputTokensDetails + type: object + ListBatchesResponse: + description: Response containing a list of batch objects. + properties: + object: + const: list + default: list + title: Object + type: string + data: + description: List of batch objects + items: + $ref: '#/components/schemas/Batch' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: ID of the first batch in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: ID of the last batch in the list + nullable: true + has_more: + default: false + description: Whether there are more batches available + title: Has More + type: boolean + required: + - data + title: ListBatchesResponse + type: object + Benchmark: + description: A benchmark resource for evaluating model performance. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: benchmark + default: benchmark + title: Type + type: string + dataset_id: + title: Dataset Id + type: string + scoring_functions: + items: + type: string + title: Scoring Functions + type: array + metadata: + additionalProperties: true + description: Metadata for this evaluation task + title: Metadata + type: object + required: + - identifier + - provider_id + - dataset_id + - scoring_functions + title: Benchmark + type: object + ImageDelta: + description: An image content delta for streaming responses. + properties: + type: + const: image + default: image + title: Type + type: string + image: + format: binary + title: Image + type: string + required: + - image + title: ImageDelta + type: object + TextDelta: + description: A text content delta for streaming responses. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextDelta + type: object + JobStatus: + description: Status of a job execution. + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + type: string + Job: + description: A job execution instance with status tracking. + properties: + job_id: + title: Job Id + type: string + status: + $ref: '#/components/schemas/JobStatus' + required: + - job_id + - status + title: Job + type: object MetricInResponse: description: A metric value included in API responses. properties: @@ -13353,6 +6925,84 @@ components: - value title: MetricInResponse type: object + PaginatedResponse: + description: A generic paginated response that follows a simple format. + properties: + data: + items: + additionalProperties: true + type: object + title: Data + type: array + has_more: + title: Has More + type: boolean + url: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + - has_more + title: PaginatedResponse + type: object + PostTrainingMetric: + description: Training metrics captured during post-training jobs. + properties: + epoch: + title: Epoch + type: integer + train_loss: + title: Train Loss + type: number + validation_loss: + title: Validation Loss + type: number + perplexity: + title: Perplexity + type: number + required: + - epoch + - train_loss + - validation_loss + - perplexity + title: PostTrainingMetric + type: object + Checkpoint: + description: Checkpoint created during training runs. + properties: + identifier: + title: Identifier + type: string + created_at: + format: date-time + title: Created At + type: string + epoch: + title: Epoch + type: integer + post_training_job_id: + title: Post Training Job Id + type: string + path: + title: Path + type: string + training_metrics: + anyOf: + - $ref: '#/components/schemas/PostTrainingMetric' + title: PostTrainingMetric + - type: 'null' + nullable: true + title: PostTrainingMetric + required: + - identifier + - created_at + - epoch + - post_training_job_id + - path + title: Checkpoint + type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: @@ -13363,6 +7013,66 @@ components: type: string title: DialogType type: object + Conversation: + description: OpenAI-compatible conversation object. + properties: + id: + description: The unique ID of the conversation. + title: Id + type: string + object: + const: conversation + default: conversation + description: The object type, which is always conversation. + title: Object + type: string + created_at: + description: The time at which the conversation was created, measured in seconds since the Unix epoch. + title: Created At + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. + nullable: true + items: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + description: Initial items to include in the conversation context. You may add up to 20 items at a time. + nullable: true + required: + - id + - created_at + title: Conversation + type: object + ConversationDeletedResource: + description: Response for deleted conversation. + properties: + id: + description: The deleted conversation identifier + title: Id + type: string + object: + default: conversation.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationDeletedResource + type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: @@ -13408,6 +7118,93 @@ components: - items title: ConversationItemCreateRequest type: object + ConversationItemDeletedResource: + description: Response for deleted conversation item. + properties: + id: + description: The deleted item identifier + title: Id + type: string + object: + default: conversation.item.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationItemDeletedResource + type: object + ConversationItemList: + description: List of conversation items with pagination. + properties: + object: + default: list + description: Object type + title: Object + type: string + data: + description: List of conversation items + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the first item in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the last item in the list + nullable: true + has_more: + default: false + description: Whether there are more items available + title: Has More + type: boolean + required: + - data + title: ConversationItemList + type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: @@ -13447,6 +7244,857 @@ components: - status title: ConversationMessage type: object + DatasetPurpose: + description: Purpose of the dataset. Each purpose has a required input data schema. + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + type: string + Dataset: + description: Dataset resource for storing and accessing training or evaluation data. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: dataset + default: dataset + title: Type + type: string + purpose: + $ref: '#/components/schemas/DatasetPurpose' + source: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + metadata: + additionalProperties: true + description: Any additional metadata for this dataset + title: Metadata + type: object + required: + - identifier + - provider_id + - purpose + - source + title: Dataset + type: object + Error: + description: Error response from the API. Roughly follows RFC 7807. + properties: + status: + title: Status + type: integer + title: + title: Title + type: string + detail: + title: Detail + type: string + instance: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - status + - title + - detail + title: Error + type: object + Api: + description: Enumeration of all available APIs in the Llama Stack system. + enum: + - providers + - inference + - safety + - agents + - batches + - vector_io + - datasetio + - scoring + - eval + - post_training + - tool_runtime + - models + - shields + - vector_stores + - datasets + - scoring_functions + - benchmarks + - tool_groups + - files + - prompts + - conversations + - inspect + title: Api + type: string + InlineProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + container_image: + anyOf: + - type: string + - type: 'null' + description: |2 + + The container image to use for this implementation. If one is provided, pip_packages will be ignored. + If a provider depends on other providers, the dependencies MUST NOT specify a container image. + nullable: true + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + title: InlineProviderSpec + type: object + ModelType: + description: Enumeration of supported model types in Llama Stack. + enum: + - llm + - embedding + - rerank + title: ModelType + type: string + Model: + description: A model resource representing an AI model registered in Llama Stack. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: model + default: model + title: Type + type: string + metadata: + additionalProperties: true + description: Any additional metadata for this model + title: Metadata + type: object + model_type: + $ref: '#/components/schemas/ModelType' + default: llm + required: + - identifier + - provider_id + title: Model + type: object + ProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + required: + - api + - provider_type + - config_class + title: ProviderSpec + type: object + RemoteProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + adapter_type: + description: Unique identifier for this adapter + title: Adapter Type + type: string + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + - adapter_type + title: RemoteProviderSpec + type: object + ScoringFn: + description: A scoring function resource for evaluating model outputs. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: scoring_function + default: scoring_function + title: Type + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + description: Any additional metadata for this definition + title: Metadata + type: object + return_type: + description: The return type of the deterministic function + discriminator: + mapping: + array: '#/components/schemas/ArrayType' + boolean: '#/components/schemas/BooleanType' + chat_completion_input: '#/components/schemas/ChatCompletionInputType' + completion_input: '#/components/schemas/CompletionInputType' + json: '#/components/schemas/JsonType' + number: '#/components/schemas/NumberType' + object: '#/components/schemas/ObjectType' + string: '#/components/schemas/StringType' + union: '#/components/schemas/UnionType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/StringType' + title: StringType + - $ref: '#/components/schemas/NumberType' + title: NumberType + - $ref: '#/components/schemas/BooleanType' + title: BooleanType + - $ref: '#/components/schemas/ArrayType' + title: ArrayType + - $ref: '#/components/schemas/ObjectType' + title: ObjectType + - $ref: '#/components/schemas/JsonType' + title: JsonType + - $ref: '#/components/schemas/UnionType' + title: UnionType + - $ref: '#/components/schemas/ChatCompletionInputType' + title: ChatCompletionInputType + - $ref: '#/components/schemas/CompletionInputType' + title: CompletionInputType + title: StringType | ... (9 variants) + params: + anyOf: + - discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + title: Params + nullable: true + required: + - identifier + - provider_id + - return_type + title: ScoringFn + type: object + Shield: + description: A safety shield resource that can be used to check content. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: shield + default: shield + title: Type + type: string + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: Shield + type: object + ToolGroup: + description: A group of related tools managed together. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: tool_group + default: tool_group + title: Type + type: string + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: ToolGroup + type: object + ModelCandidate: + description: A model candidate for evaluation. + properties: + type: + const: model + default: model + title: Type + type: string + model: + title: Model + type: string + sampling_params: + $ref: '#/components/schemas/SamplingParams' + system_message: + anyOf: + - $ref: '#/components/schemas/SystemMessage' + title: SystemMessage + - type: 'null' + nullable: true + title: SystemMessage + required: + - model + - sampling_params + title: ModelCandidate + type: object + SamplingParams: + description: Sampling parameters. + properties: + strategy: + discriminator: + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreedySamplingStrategy' + title: GreedySamplingStrategy + - $ref: '#/components/schemas/TopPSamplingStrategy' + title: TopPSamplingStrategy + - $ref: '#/components/schemas/TopKSamplingStrategy' + title: TopKSamplingStrategy + title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + repetition_penalty: + anyOf: + - type: number + - type: 'null' + default: 1.0 + stop: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: SamplingParams + type: object + SystemMessage: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + title: string | list[ImageContentItem | TextContentItem] + required: + - content + title: SystemMessage + type: object + BenchmarkConfig: + description: A benchmark configuration for evaluation. + properties: + eval_candidate: + $ref: '#/components/schemas/ModelCandidate' + scoring_params: + additionalProperties: + discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + description: Map between scoring function id and parameters for each scoring function you want to run + title: Scoring Params + type: object + num_examples: + anyOf: + - type: integer + - type: 'null' + description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated + nullable: true + required: + - eval_candidate + title: BenchmarkConfig + type: object + ScoringResult: + description: A scoring result for a single row. + properties: + score_rows: + items: + additionalProperties: true + type: object + title: Score Rows + type: array + aggregated_results: + additionalProperties: true + title: Aggregated Results + type: object + required: + - score_rows + - aggregated_results + title: ScoringResult + type: object + EvaluateResponse: + description: The response from an evaluation. + properties: + generations: + items: + additionalProperties: true + type: object + title: Generations + type: array + scores: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Scores + type: object + required: + - generations + - scores + title: EvaluateResponse + type: object + ExpiresAfter: + description: |- + Control expiration of uploaded files. + + Params: + - anchor, must be "created_at" + - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) + properties: + anchor: + const: created_at + title: Anchor + type: string + seconds: + maximum: 2592000 + minimum: 3600 + title: Seconds + type: integer + required: + - anchor + - seconds + title: ExpiresAfter + type: object + OpenAIFileObject: + description: OpenAI File object as defined in the OpenAI Files API. + properties: + object: + const: file + default: file + title: Object + type: string + id: + title: Id + type: string + bytes: + title: Bytes + type: integer + created_at: + title: Created At + type: integer + expires_at: + title: Expires At + type: integer + filename: + title: Filename + type: string + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + required: + - id + - bytes + - created_at + - expires_at + - filename + - purpose + title: OpenAIFileObject + type: object + OpenAIFilePurpose: + description: Valid purpose values for OpenAI Files API. + enum: + - assistants + - batch + title: OpenAIFilePurpose + type: string + ListOpenAIFileResponse: + description: Response for listing files in OpenAI Files API. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIFileObject' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIFileResponse + type: object + OpenAIFileDeleteResponse: + description: Response for deleting a file in OpenAI Files API. + properties: + id: + title: Id + type: string + object: + const: file + default: file + title: Object + type: string + deleted: + title: Deleted + type: boolean + required: + - id + - deleted + title: OpenAIFileDeleteResponse + type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: @@ -13496,6 +8144,304 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig type: object + OpenAIChatCompletionUsage: + description: Usage information for OpenAI chat completion. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + completion_tokens: + title: Completion Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + prompt_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' + title: OpenAIChatCompletionUsagePromptTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + completion_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' + title: OpenAIChatCompletionUsageCompletionTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + required: + - prompt_tokens + - completion_tokens + - total_tokens + title: OpenAIChatCompletionUsage + type: object + OpenAIChatCompletionUsageCompletionTokensDetails: + description: Token details for output tokens in OpenAI chat completion usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + type: object + OpenAIChatCompletionUsagePromptTokensDetails: + description: Token details for prompt tokens in OpenAI chat completion usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + type: object + OpenAIChoice: + description: A choice from an OpenAI-compatible chat completion response. + properties: + message: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + finish_reason: + title: Finish Reason + type: string + index: + title: Index + type: integer + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + required: + - message + - finish_reason + - index + title: OpenAIChoice + type: object + OpenAIChoiceLogprobs: + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. + properties: + content: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + refusal: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + type: object + OpenAICompletionWithInputMessages: + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + input_messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + title: Input Messages + type: array + required: + - id + - choices + - created + - model + - input_messages + title: OpenAICompletionWithInputMessages + type: object + OpenAITokenLogProb: + description: |- + The log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + :top_logprobs: The top log probabilities for the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + title: Top Logprobs + type: array + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb + type: object + OpenAITopLogProb: + description: |- + The top log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + required: + - token + - logprob + title: OpenAITopLogProb + type: object + ListOpenAIChatCompletionResponse: + description: Response from listing OpenAI-compatible chat completions. + properties: + data: + items: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIChatCompletionResponse + type: object + OpenAIChatCompletion: + description: Response from an OpenAI-compatible chat completion request. + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + required: + - id + - choices + - created + - model + title: OpenAIChatCompletion + type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: @@ -13528,25 +8474,6 @@ components: nullable: true title: OpenAIChoiceDelta type: object - OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - title: OpenAIChoiceLogprobs - type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: @@ -13607,48 +8534,181 @@ components: - model title: OpenAIChatCompletionChunk type: object - OpenAIChoice: - description: A choice from an OpenAI-compatible chat completion response. + OpenAIChatCompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible chat completion endpoint. properties: - message: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - finish_reason: - title: Finish Reason + model: + title: Model type: string - index: - title: Index - type: integer - logprobs: + messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + minItems: 1 + title: Messages + type: array + frequency_penalty: anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs' - title: OpenAIChoiceLogprobs + - type: number + - type: 'null' + nullable: true + function_call: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + functions: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_completion_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + response_format: + anyOf: + - discriminator: + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseFormatText' + title: OpenAIResponseFormatText + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + title: OpenAIResponseFormatJSONSchema + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + title: OpenAIResponseFormatJSONObject + title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + - type: 'null' + title: Response Format + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + tool_choice: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + tools: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + top_logprobs: + anyOf: + - type: integer + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string - type: 'null' nullable: true - title: OpenAIChoiceLogprobs required: - - message - - finish_reason - - index - title: OpenAIChoice + - model + - messages + title: OpenAIChatCompletionRequestWithExtraBody type: object OpenAICompletionChoice: description: |- @@ -13681,6 +8741,42 @@ components: - index title: OpenAICompletionChoice type: object + OpenAICompletion: + description: |- + Response from an OpenAI-compatible completion request. + + :id: The ID of the completion + :choices: List of choices + :created: The Unix timestamp in seconds when the completion was created + :model: The model that was used to generate the completion + :object: The object type, which will be "text_completion" + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + title: Choices + type: array + created: + title: Created + type: integer + model: + title: Model + type: string + object: + const: text_completion + default: text_completion + title: Object + type: string + required: + - id + - choices + - created + - model + title: OpenAICompletion + type: object OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -13722,6 +8818,247 @@ components: nullable: true title: OpenAICompletionLogprobs type: object + OpenAICompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible completion endpoint. + properties: + model: + title: Model + type: string + prompt: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - items: + type: integer + type: array + title: list[integer] + - items: + items: + type: integer + type: array + type: array + title: list[array] + title: string | ... (4 variants) + best_of: + anyOf: + - type: integer + - type: 'null' + nullable: true + echo: + anyOf: + - type: boolean + - type: 'null' + nullable: true + frequency_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + suffix: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - prompt + title: OpenAICompletionRequestWithExtraBody + type: object + OpenAIEmbeddingData: + description: A single embedding data object from an OpenAI-compatible embeddings response. + properties: + object: + const: embedding + default: embedding + title: Object + type: string + embedding: + anyOf: + - items: + type: number + type: array + title: list[number] + - type: string + title: list[number] | string + index: + title: Index + type: integer + required: + - embedding + - index + title: OpenAIEmbeddingData + type: object + OpenAIEmbeddingUsage: + description: Usage information for an OpenAI-compatible embeddings response. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + required: + - prompt_tokens + - total_tokens + title: OpenAIEmbeddingUsage + type: object + OpenAIEmbeddingsRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible embeddings endpoint. + properties: + model: + title: Model + type: string + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + encoding_format: + anyOf: + - type: string + - type: 'null' + default: float + dimensions: + anyOf: + - type: integer + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - input + title: OpenAIEmbeddingsRequestWithExtraBody + type: object + OpenAIEmbeddingsResponse: + description: Response from an OpenAI-compatible embeddings request. + properties: + object: + const: list + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/OpenAIEmbeddingData' + title: Data + type: array + model: + title: Model + type: string + usage: + $ref: '#/components/schemas/OpenAIEmbeddingUsage' + required: + - data + - model + - usage + title: OpenAIEmbeddingsResponse + type: object + RerankData: + description: A single rerank result from a reranking response. + properties: + index: + title: Index + type: integer + relevance_score: + title: Relevance Score + type: number + required: + - index + - relevance_score + title: RerankData + type: object + RerankResponse: + description: Response from a reranking request. + properties: + data: + items: + $ref: '#/components/schemas/RerankData' + title: Data + type: array + required: + - data + title: RerankResponse + type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: @@ -13851,6 +9188,233 @@ components: - content title: UserMessage type: object + HealthStatus: + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + type: string + HealthInfo: + description: Health status information for the service. + properties: + status: + $ref: '#/components/schemas/HealthStatus' + required: + - status + title: HealthInfo + type: object + RouteInfo: + description: Information about an API route including its path, method, and implementing providers. + properties: + route: + title: Route + type: string + method: + title: Method + type: string + provider_types: + items: + type: string + title: Provider Types + type: array + required: + - route + - method + - provider_types + title: RouteInfo + type: object + ListRoutesResponse: + description: Response containing a list of all available API routes. + properties: + data: + items: + $ref: '#/components/schemas/RouteInfo' + title: Data + type: array + required: + - data + title: ListRoutesResponse + type: object + VersionInfo: + description: Version information for the service. + properties: + version: + title: Version + type: string + required: + - version + title: VersionInfo + type: object + OpenAIModel: + description: |- + A model from OpenAI. + + :id: The ID of the model + :object: The object type, which will be "model" + :created: The Unix timestamp in seconds when the model was created + :owned_by: The owner of the model + :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata + properties: + id: + title: Id + type: string + object: + const: model + default: model + title: Object + type: string + created: + title: Created + type: integer + owned_by: + title: Owned By + type: string + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - id + - created + - owned_by + title: OpenAIModel + type: object + DPOLossType: + enum: + - sigmoid + - hinge + - ipo + - kto_pair + title: DPOLossType + type: string + DPOAlignmentConfig: + description: Configuration for Direct Preference Optimization (DPO) alignment. + properties: + beta: + title: Beta + type: number + loss_type: + $ref: '#/components/schemas/DPOLossType' + default: sigmoid + required: + - beta + title: DPOAlignmentConfig + type: object + DatasetFormat: + description: Format of the training dataset. + enum: + - instruct + - dialog + title: DatasetFormat + type: string + DataConfig: + description: Configuration for training data and data loading. + properties: + dataset_id: + title: Dataset Id + type: string + batch_size: + title: Batch Size + type: integer + shuffle: + title: Shuffle + type: boolean + data_format: + $ref: '#/components/schemas/DatasetFormat' + validation_dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + packed: + anyOf: + - type: boolean + - type: 'null' + default: false + train_on_input: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - dataset_id + - batch_size + - shuffle + - data_format + title: DataConfig + type: object + EfficiencyConfig: + description: Configuration for memory and compute efficiency optimizations. + properties: + enable_activation_checkpointing: + anyOf: + - type: boolean + - type: 'null' + default: false + enable_activation_offloading: + anyOf: + - type: boolean + - type: 'null' + default: false + memory_efficient_fsdp_wrap: + anyOf: + - type: boolean + - type: 'null' + default: false + fsdp_cpu_offload: + anyOf: + - type: boolean + - type: 'null' + default: false + title: EfficiencyConfig + type: object + OptimizerType: + description: Available optimizer algorithms for training. + enum: + - adam + - adamw + - sgd + title: OptimizerType + type: string + OptimizerConfig: + description: Configuration parameters for the optimization algorithm. + properties: + optimizer_type: + $ref: '#/components/schemas/OptimizerType' + lr: + title: Lr + type: number + weight_decay: + title: Weight Decay + type: number + num_warmup_steps: + title: Num Warmup Steps + type: integer + required: + - optimizer_type + - lr + - weight_decay + - num_warmup_steps + title: OptimizerConfig + type: object + PostTrainingJobArtifactsResponse: + description: Artifacts of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + title: PostTrainingJobArtifactsResponse + type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -13867,12 +9431,103 @@ components: - log_lines title: PostTrainingJobLogStream type: object + PostTrainingJobStatusResponse: + description: Status of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + status: + $ref: '#/components/schemas/JobStatus' + scheduled_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + started_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + completed_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + resources_allocated: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + - status + title: PostTrainingJobStatusResponse + type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string + TrainingConfig: + description: Comprehensive configuration for the training process. + properties: + n_epochs: + title: N Epochs + type: integer + max_steps_per_epoch: + default: 1 + title: Max Steps Per Epoch + type: integer + gradient_accumulation_steps: + default: 1 + title: Gradient Accumulation Steps + type: integer + max_validation_steps: + anyOf: + - type: integer + - type: 'null' + default: 1 + data_config: + anyOf: + - $ref: '#/components/schemas/DataConfig' + title: DataConfig + - type: 'null' + nullable: true + title: DataConfig + optimizer_config: + anyOf: + - $ref: '#/components/schemas/OptimizerConfig' + title: OptimizerConfig + - type: 'null' + nullable: true + title: OptimizerConfig + efficiency_config: + anyOf: + - $ref: '#/components/schemas/EfficiencyConfig' + title: EfficiencyConfig + - type: 'null' + nullable: true + title: EfficiencyConfig + dtype: + anyOf: + - type: string + - type: 'null' + default: bf16 + required: + - n_epochs + title: TrainingConfig + type: object PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: @@ -13904,179 +9559,6 @@ components: title: Logger Config type: object required: -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -======= ->>>>>>> 87bc7442f (chore: re-add missing endpoints) - - job_uuid - - training_config - - hyperparam_search_config - - logger_config - title: SupervisedFineTuneRequest -<<<<<<< HEAD - RegisterModelRequest: - type: object - properties: - model_id: - type: string - description: The identifier of the model to register. - provider_model_id: - type: string - description: >- - The identifier of the model in the provider. - provider_id: - type: string - description: The identifier of the provider. - metadata: - type: object - additionalProperties: - oneOf: - - 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 - title: RegisterModelRequest - 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' - discriminator: - propertyName: type - mapping: - string: '#/components/schemas/StringType' - number: '#/components/schemas/NumberType' - boolean: '#/components/schemas/BooleanType' - array: '#/components/schemas/ArrayType' - object: '#/components/schemas/ObjectType' - json: '#/components/schemas/JsonType' - union: '#/components/schemas/UnionType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - RegisterScoringFunctionRequest: - type: object - properties: - scoring_fn_id: - type: string - description: >- - The ID of the scoring function to register. - description: - type: string - description: The description of the scoring function. - return_type: - $ref: '#/components/schemas/ParamType' - 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. - provider_id: - type: string - 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. - additionalProperties: false - required: - - scoring_fn_id - - description - - return_type - title: RegisterScoringFunctionRequest - RegisterShieldRequest: - type: object - properties: - shield_id: - type: string - description: >- - The identifier of the shield to register. - provider_shield_id: - type: string - description: >- - The identifier of the shield in the provider. - provider_id: - type: string - description: The identifier of the provider. - params: - type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: The parameters of the shield. - additionalProperties: false - required: - - shield_id - title: RegisterShieldRequest - RegisterToolGroupRequest: - type: object - properties: - toolgroup_id: - type: string - 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. - mcp_endpoint: - $ref: '#/components/schemas/URL' - 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. - additionalProperties: false - required: - - toolgroup_id - - provider_id - title: RegisterToolGroupRequest -======= ->>>>>>> 87bc7442f (chore: re-add missing endpoints) - DataSource: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - - $ref: '#/components/schemas/RowsDataSource' - discriminator: - propertyName: type - mapping: - uri: '#/components/schemas/URIDataSource' - rows: '#/components/schemas/RowsDataSource' - RegisterDatasetRequest: -<<<<<<< HEAD -======= -======= ->>>>>>> 9c248d3e0 (fix: Query default values can't be set in Annotated) - job_uuid - finetuned_model - dataset_id @@ -14088,12 +9570,247 @@ components: - hyperparam_search_config - logger_config title: PostTrainingRLHFRequest -<<<<<<< HEAD ->>>>>>> ceca36b91 (chore: regen scehma with main) -======= ->>>>>>> 87bc7442f (chore: re-add missing endpoints) -======= ->>>>>>> 9c248d3e0 (fix: Query default values can't be set in Annotated) + type: object + Prompt: + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. + properties: + prompt: + anyOf: + - type: string + - type: 'null' + description: The system prompt with variable placeholders + nullable: true + version: + description: Version (integer starting at 1, incremented on save) + minimum: 1 + title: Version + type: integer + prompt_id: + description: Unique identifier in format 'pmpt_<48-digit-hash>' + title: Prompt Id + type: string + variables: + description: List of variable names that can be used in the prompt template + items: + type: string + title: Variables + type: array + is_default: + default: false + description: Boolean indicating whether this version is the default version + title: Is Default + type: boolean + required: + - version + - prompt_id + title: Prompt + type: object + ProviderInfo: + description: Information about a registered provider including its configuration and health status. + properties: + api: + title: Api + type: string + provider_id: + title: Provider Id + type: string + provider_type: + title: Provider Type + type: string + config: + additionalProperties: true + title: Config + type: object + health: + additionalProperties: true + title: Health + type: object + required: + - api + - provider_id + - provider_type + - config + - health + title: ProviderInfo + type: object + ModerationObjectResults: + description: A moderation object. + properties: + flagged: + title: Flagged + type: boolean + categories: + anyOf: + - additionalProperties: + type: boolean + type: object + - type: 'null' + nullable: true + category_applied_input_types: + anyOf: + - additionalProperties: + items: + type: string + type: array + type: object + - type: 'null' + nullable: true + category_scores: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - flagged + title: ModerationObjectResults + type: object + ModerationObject: + description: A moderation object. + properties: + id: + title: Id + type: string + model: + title: Model + type: string + results: + items: + $ref: '#/components/schemas/ModerationObjectResults' + title: Results + type: array + required: + - id + - model + - results + title: ModerationObject + type: object + SafetyViolation: + description: Details of a safety violation detected by content moderation. + properties: + violation_level: + $ref: '#/components/schemas/ViolationLevel' + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - violation_level + title: SafetyViolation + type: object + ViolationLevel: + description: Severity level of a safety violation. + enum: + - info + - warn + - error + title: ViolationLevel + type: string + RunShieldResponse: + description: Response from running a safety shield. + properties: + violation: + anyOf: + - $ref: '#/components/schemas/SafetyViolation' + title: SafetyViolation + - type: 'null' + nullable: true + title: SafetyViolation + title: RunShieldResponse + type: object + ScoreBatchResponse: + description: Response from batch scoring operations on datasets. + properties: + dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreBatchResponse + type: object + ScoreResponse: + description: The response from scoring. + properties: + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreResponse + type: object + ToolDef: + description: Tool definition used in runtime contexts. + properties: + toolgroup_id: + anyOf: + - type: string + - type: 'null' + nullable: true + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + input_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + output_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - name + title: ToolDef + type: object + ListToolDefsResponse: + description: Response containing a list of tool definitions. + properties: + data: + items: + $ref: '#/components/schemas/ToolDef' + title: Data + type: array + required: + - data + title: ListToolDefsResponse type: object ToolGroupInput: description: Input data for registering a tool group. @@ -14122,6 +9839,122 @@ components: - provider_id title: ToolGroupInput type: object + ToolInvocationResult: + description: Result of a tool invocation. + properties: + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + - type: 'null' + title: string | list[ImageContentItem | TextContentItem] + nullable: true + error_message: + anyOf: + - type: string + - type: 'null' + nullable: true + error_code: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: ToolInvocationResult + type: object + ChunkMetadata: + description: |- + `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that + will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` + is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. + Use `Chunk.metadata` for metadata that will be used in the context during inference. + properties: + chunk_id: + anyOf: + - type: string + - type: 'null' + nullable: true + document_id: + anyOf: + - type: string + - type: 'null' + nullable: true + source: + anyOf: + - type: string + - type: 'null' + nullable: true + created_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + updated_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + chunk_window: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_tokenizer: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_model: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_dimension: + anyOf: + - type: integer + - type: 'null' + nullable: true + content_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: ChunkMetadata + type: object Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -14180,6 +10013,140 @@ components: - chunk_id title: Chunk type: object + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store file batch with extra_body support. + properties: + file_ids: + items: + type: string + title: File Ids + type: array + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + required: + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + type: object + OpenAICreateVectorStoreRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store with extra_body support. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + file_ids: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: OpenAICreateVectorStoreRequestWithExtraBody + type: object + QueryChunksResponse: + description: Response from querying chunks in a vector database. + properties: + chunks: + items: + $ref: '#/components/schemas/Chunk' + title: Chunks + type: array + scores: + items: + type: number + title: Scores + type: array + required: + - chunks + - scores + title: QueryChunksResponse + type: object + VectorStoreContent: + description: Content item from a vector store file or search result. + properties: + type: + const: text + title: Type + type: string + text: + title: Text + type: string + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + nullable: true + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + nullable: true + title: ChunkMetadata + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - type + - text + title: VectorStoreContent + type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: @@ -14211,6 +10178,351 @@ components: type: object title: VectorStoreCreateRequest type: object + VectorStoreDeleteResponse: + description: Response from deleting a vector store. + properties: + id: + title: Id + type: string + object: + default: vector_store.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreDeleteResponse + type: object + VectorStoreFileCounts: + description: File processing status counts for a vector store. + properties: + completed: + title: Completed + type: integer + cancelled: + title: Cancelled + type: integer + failed: + title: Failed + type: integer + in_progress: + title: In Progress + type: integer + total: + title: Total + type: integer + required: + - completed + - cancelled + - failed + - in_progress + - total + title: VectorStoreFileCounts + type: object + VectorStoreFileBatchObject: + description: OpenAI Vector Store File Batch object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file_batch + title: Object + type: string + created_at: + title: Created At + type: integer + vector_store_id: + title: Vector Store Id + type: string + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + required: + - id + - created_at + - vector_store_id + - status + - file_counts + title: VectorStoreFileBatchObject + type: object + VectorStoreFileContentResponse: + description: Represents the parsed content of a vector store file. + properties: + object: + const: vector_store.file_content.page + default: vector_store.file_content.page + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreContent' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + title: VectorStoreFileContentResponse + type: object + VectorStoreFileDeleteResponse: + description: Response from deleting a vector store file. + properties: + id: + title: Id + type: string + object: + default: vector_store.file.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreFileDeleteResponse + type: object + VectorStoreFileLastError: + description: Error information for failed vector store file processing. + properties: + code: + title: Code + type: string + enum: + - server_error + - rate_limit_exceeded + default: server_error + message: + title: Message + type: string + required: + - code + - message + title: VectorStoreFileLastError + type: object + VectorStoreFileObject: + description: OpenAI Vector Store File object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file + title: Object + type: string + attributes: + additionalProperties: true + title: Attributes + type: object + chunking_strategy: + discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + created_at: + title: Created At + type: integer + last_error: + anyOf: + - $ref: '#/components/schemas/VectorStoreFileLastError' + title: VectorStoreFileLastError + - type: 'null' + nullable: true + title: VectorStoreFileLastError + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + vector_store_id: + title: Vector Store Id + type: string + required: + - id + - chunking_strategy + - created_at + - status + - vector_store_id + title: VectorStoreFileObject + type: object + VectorStoreFilesListInBatchResponse: + description: Response from listing files in a vector store file batch. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreFilesListInBatchResponse + type: object + VectorStoreListFilesResponse: + description: Response from listing files in a vector store. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListFilesResponse + type: object + VectorStoreObject: + description: OpenAI Vector Store object. + properties: + id: + title: Id + type: string + object: + default: vector_store + title: Object + type: string + created_at: + title: Created At + type: integer + name: + anyOf: + - type: string + - type: 'null' + nullable: true + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + status: + default: completed + title: Status + type: string + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + last_active_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - id + - created_at + - file_counts + title: VectorStoreObject + type: object + VectorStoreListResponse: + description: Response from listing vector stores. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListResponse + type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: @@ -14303,149 +10615,34 @@ components: - content title: VectorStoreSearchResponse type: object - _safety_run_shield_Request: + VectorStoreSearchResponsePage: + description: Paginated response from searching a vector store. properties: - shield_id: - title: Shield Id + object: + default: vector_store.search_results.page + title: Object type: string - messages: + search_query: items: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Messages + type: string + title: Search Query type: array - params: - additionalProperties: true - title: Params - type: object + data: + items: + $ref: '#/components/schemas/VectorStoreSearchResponse' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true required: - - shield_id - - messages - - params - title: _safety_run_shield_Request + - search_query + - data + title: VectorStoreSearchResponsePage type: object - OpenAIResponseMessageOutputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageOutputOneOf - title: OpenAIResponseMessage-Output | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageOutputUnion - OpenAIResponseMessageInputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageInputOneOf - title: OpenAIResponseMessage-Input | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageInputUnion - responses: - BadRequest400: - description: The request was invalid or malformed - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 400 - title: Bad Request - detail: The request was invalid or malformed - TooManyRequests429: - description: The client has sent too many requests in a given amount of time - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 429 - title: Too Many Requests - detail: You have exceeded the rate limit. Please try again later. - InternalServerError500: - description: The server encountered an unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 500 - title: Internal Server Error - detail: An unexpected error occurred - DefaultError: - description: An error occurred - content: - application/json: - schema: - $ref: '#/components/schemas/Error' diff --git a/docs/static/deprecated-llama-stack-spec.yaml b/docs/static/deprecated-llama-stack-spec.yaml index e31c38482..e0bb216d7 100644 --- a/docs/static/deprecated-llama-stack-spec.yaml +++ b/docs/static/deprecated-llama-stack-spec.yaml @@ -18,18 +18,13 @@ paths: tags: - Models summary: Get Model - description: |- - Get model. - - Get a model by its identifier. operationId: get_model_v1_models__model_id__get responses: '200': - description: A Model. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Model' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -53,10 +48,6 @@ paths: tags: - Models summary: Unregister Model - description: |- - Unregister model. - - Unregister a model. operationId: unregister_model_v1_models__model_id__delete responses: '200': @@ -89,15 +80,13 @@ paths: tags: - Models summary: Openai List Models - description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get responses: '200': - description: A OpenAIListModelsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIListModelsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -114,24 +103,13 @@ paths: tags: - Models summary: Register Model - description: |- - Register model. - - Register a model. operationId: register_model_v1_models_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_models_Request' - required: true responses: '200': - description: A Model. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Model' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -150,15 +128,13 @@ paths: tags: - Shields summary: Get Shield - description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -182,7 +158,6 @@ paths: tags: - Shields summary: Unregister Shield - description: Unregister a shield. operationId: unregister_shield_v1_shields__identifier__delete responses: '200': @@ -215,15 +190,13 @@ paths: tags: - Shields summary: List Shields - description: List all shields. operationId: list_shields_v1_shields_get responses: '200': - description: A ListShieldsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListShieldsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -240,21 +213,13 @@ paths: tags: - Shields summary: Register Shield - description: Register a shield. operationId: register_shield_v1_shields_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_shields_Request' - required: true responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -273,15 +238,13 @@ paths: tags: - Datasets summary: Get Dataset - description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get responses: '200': - description: A Dataset. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Dataset' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -305,7 +268,6 @@ paths: tags: - Datasets summary: Unregister Dataset - description: Unregister a dataset by its ID. operationId: unregister_dataset_v1beta_datasets__dataset_id__delete responses: '200': @@ -338,15 +300,13 @@ paths: tags: - Datasets summary: List Datasets - description: List all datasets. operationId: list_datasets_v1beta_datasets_get responses: '200': - description: A ListDatasetsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListDatasetsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -363,21 +323,13 @@ paths: tags: - Datasets summary: Register Dataset - description: Register a new dataset. operationId: register_dataset_v1beta_datasets_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_datasets_Request' - required: true responses: '200': - description: A Dataset. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Dataset' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -396,15 +348,13 @@ paths: tags: - Scoring Functions summary: Get Scoring Function - description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get responses: '200': - description: A ScoringFn. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoringFn' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -428,7 +378,6 @@ paths: tags: - Scoring Functions summary: Unregister Scoring Function - description: Unregister a scoring function. operationId: unregister_scoring_function_v1_scoring_functions__scoring_fn_id__delete responses: '200': @@ -461,40 +410,7 @@ paths: tags: - Scoring Functions summary: List Scoring Functions - description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get - responses: - '200': - description: A ListScoringFunctionsResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListScoringFunctionsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response - post: - tags: - - Scoring Functions - summary: Register Scoring Function - description: Register a scoring function. - operationId: register_scoring_function_v1_scoring_functions_post - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Body_register_scoring_function_v1_scoring_functions_post' responses: '200': description: Successful Response @@ -502,31 +418,53 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' + post: + tags: + - Scoring Functions + summary: Register Scoring Function + operationId: register_scoring_function_v1_scoring_functions_post + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' + deprecated: true /v1alpha/eval/benchmarks/{benchmark_id}: get: tags: - Benchmarks summary: Get Benchmark - description: Get a benchmark by its ID. operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get responses: '200': - description: A Benchmark. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Benchmark' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -550,7 +488,6 @@ paths: tags: - Benchmarks summary: Unregister Benchmark - description: Unregister a benchmark. operationId: unregister_benchmark_v1alpha_eval_benchmarks__benchmark_id__delete responses: '200': @@ -583,40 +520,7 @@ paths: tags: - Benchmarks summary: List Benchmarks - description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get - responses: - '200': - description: A ListBenchmarksResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBenchmarksResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response - post: - tags: - - Benchmarks - summary: Register Benchmark - description: Register a benchmark. - operationId: register_benchmark_v1alpha_eval_benchmarks_post - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Body_register_benchmark_v1alpha_eval_benchmarks_post' responses: '200': description: Successful Response @@ -624,31 +528,53 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' + post: + tags: + - Benchmarks + summary: Register Benchmark + operationId: register_benchmark_v1alpha_eval_benchmarks_post + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' + deprecated: true /v1/toolgroups/{toolgroup_id}: get: tags: - Tool Groups summary: Get Tool Group - description: Get a tool group by its ID. operationId: get_tool_group_v1_toolgroups__toolgroup_id__get responses: '200': - description: A ToolGroup. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolGroup' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -672,7 +598,6 @@ paths: tags: - Tool Groups summary: Unregister Toolgroup - description: Unregister a tool group. operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete responses: '200': @@ -705,39 +630,7 @@ paths: tags: - Tool Groups summary: List Tool Groups - description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get - responses: - '200': - description: A ListToolGroupsResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListToolGroupsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response - post: - tags: - - Tool Groups - summary: Register Tool Group - description: Register a tool group. - operationId: register_tool_group_v1_toolgroups_post - deprecated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Body_register_tool_group_v1_toolgroups_post' responses: '200': description: Successful Response @@ -745,6414 +638,80 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' + post: + tags: + - Tool Groups + summary: Register Tool Group + operationId: register_tool_group_v1_toolgroups_post + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' + deprecated: true components: + responses: + BadRequest400: + description: The request was invalid or malformed + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 400 + title: Bad Request + detail: The request was invalid or malformed + TooManyRequests429: + description: The client has sent too many requests in a given amount of time + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 429 + title: Too Many Requests + detail: You have exceeded the rate limit. Please try again later. + InternalServerError500: + description: The server encountered an unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 500 + title: Internal Server Error + detail: An unexpected error occurred + DefaultError: + description: An error occurred + content: + application/json: + schema: + $ref: '#/components/schemas/Error' schemas: - AggregationFunctionType: - type: string - enum: - - average - - weighted_average - - median - - categorical_count - - accuracy - title: AggregationFunctionType - description: Types of aggregation functions for scoring results. - AllowedToolsFilter: - properties: - tool_names: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: AllowedToolsFilter - description: Filter configuration for restricting which MCP tools can be used. - ApprovalFilter: - properties: - always: - anyOf: - - items: - type: string - type: array - - type: 'null' - never: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: ApprovalFilter - description: Filter configuration for MCP tool approval requirements. - ArrayType: - properties: - type: - type: string - const: array - title: Type - default: array - type: object - title: ArrayType - description: Parameter type for array values. - BasicScoringFnParams: - properties: - type: - type: string - const: basic - title: Type - default: basic - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: BasicScoringFnParams - description: Parameters for basic scoring function configuration. - Batch: - properties: - id: - type: string - title: Id - completion_window: - type: string - title: Completion Window - created_at: - type: integer - title: Created At - endpoint: - type: string - title: Endpoint - input_file_id: - type: string - title: Input File Id - object: - type: string - const: batch - title: Object - status: - type: string - enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled - title: Status - cancelled_at: - anyOf: - - type: integer - - type: 'null' - cancelling_at: - anyOf: - - type: integer - - type: 'null' - completed_at: - anyOf: - - type: integer - - type: 'null' - error_file_id: - anyOf: - - type: string - - type: 'null' - errors: - anyOf: - - $ref: '#/components/schemas/Errors' - title: Errors - - type: 'null' - title: Errors - expired_at: - anyOf: - - type: integer - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - failed_at: - anyOf: - - type: integer - - type: 'null' - finalizing_at: - anyOf: - - type: integer - - type: 'null' - in_progress_at: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - model: - anyOf: - - type: string - - type: 'null' - output_file_id: - anyOf: - - type: string - - type: 'null' - request_counts: - anyOf: - - $ref: '#/components/schemas/BatchRequestCounts' - title: BatchRequestCounts - - type: 'null' - title: BatchRequestCounts - usage: - anyOf: - - $ref: '#/components/schemas/BatchUsage' - title: BatchUsage - - type: 'null' - title: BatchUsage - additionalProperties: true - type: object - required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status - title: Batch - BatchError: - properties: - code: - anyOf: - - type: string - - type: 'null' - line: - anyOf: - - type: integer - - type: 'null' - message: - anyOf: - - type: string - - type: 'null' - param: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: BatchError - BatchRequestCounts: - properties: - completed: - type: integer - title: Completed - failed: - type: integer - title: Failed - total: - type: integer - title: Total - additionalProperties: true - type: object - required: - - completed - - failed - - total - title: BatchRequestCounts - BatchUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - input_tokens_details: - $ref: '#/components/schemas/InputTokensDetails' - output_tokens: - type: integer - title: Output Tokens - output_tokens_details: - $ref: '#/components/schemas/OutputTokensDetails' - total_tokens: - type: integer - title: Total Tokens - additionalProperties: true - type: object - required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens - title: BatchUsage - Benchmark: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: benchmark - title: Type - default: benchmark - dataset_id: - type: string - title: Dataset Id - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - metadata: - additionalProperties: true - type: object - title: Metadata - description: Metadata for this evaluation task - type: object - required: - - identifier - - provider_id - - dataset_id - - scoring_functions - title: Benchmark - description: A benchmark resource for evaluating model performance. - BenchmarkConfig: - properties: - eval_candidate: - $ref: '#/components/schemas/ModelCandidate' - scoring_params: - additionalProperties: - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: object - title: Scoring Params - description: Map between scoring function id and parameters for each scoring function you want to run - num_examples: - anyOf: - - type: integer - - type: 'null' - description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated - type: object - required: - - eval_candidate - title: BenchmarkConfig - description: A benchmark configuration for evaluation. - Body_openai_upload_file_v1_files_post: - properties: - file: - type: string - format: binary - title: File - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - expires_after: - anyOf: - - $ref: '#/components/schemas/ExpiresAfter' - title: ExpiresAfter - - type: 'null' - title: ExpiresAfter - type: object - required: - - file - - purpose - title: Body_openai_upload_file_v1_files_post - Body_register_benchmark_v1alpha_eval_benchmarks_post: - properties: - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - scoring_functions - title: Body_register_benchmark_v1alpha_eval_benchmarks_post - Body_register_scoring_function_v1_scoring_functions_post: - properties: - return_type: - anyOf: - - $ref: '#/components/schemas/StringType' - title: StringType - - $ref: '#/components/schemas/NumberType' - title: NumberType - - $ref: '#/components/schemas/BooleanType' - title: BooleanType - - $ref: '#/components/schemas/ArrayType' - title: ArrayType - - $ref: '#/components/schemas/ObjectType' - title: ObjectType - - $ref: '#/components/schemas/JsonType' - title: JsonType - - $ref: '#/components/schemas/UnionType' - title: UnionType - - $ref: '#/components/schemas/ChatCompletionInputType' - title: ChatCompletionInputType - - $ref: '#/components/schemas/CompletionInputType' - title: CompletionInputType - title: StringType | ... (9 variants) - params: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: Params - type: object - required: - - return_type - title: Body_register_scoring_function_v1_scoring_functions_post - Body_register_tool_group_v1_toolgroups_post: - properties: - mcp_endpoint: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - args: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: Body_register_tool_group_v1_toolgroups_post - BooleanType: - properties: - type: - type: string - const: boolean - title: Type - default: boolean - type: object - title: BooleanType - description: Parameter type for boolean values. - ChatCompletionInputType: - properties: - type: - type: string - const: chat_completion_input - title: Type - default: chat_completion_input - type: object - title: ChatCompletionInputType - description: Parameter type for chat completion input. - Checkpoint: - properties: - identifier: - type: string - title: Identifier - created_at: - type: string - format: date-time - title: Created At - epoch: - type: integer - title: Epoch - post_training_job_id: - type: string - title: Post Training Job Id - path: - type: string - title: Path - training_metrics: - anyOf: - - $ref: '#/components/schemas/PostTrainingMetric' - title: PostTrainingMetric - - type: 'null' - title: PostTrainingMetric - type: object - required: - - identifier - - created_at - - epoch - - post_training_job_id - - path - title: Checkpoint - description: Checkpoint created during training runs. - Chunk-Input: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - Chunk-Output: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - title: string | list[ImageContentItem-Output | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - ChunkMetadata: - properties: - chunk_id: - anyOf: - - type: string - - type: 'null' - document_id: - anyOf: - - type: string - - type: 'null' - source: - anyOf: - - type: string - - type: 'null' - created_timestamp: - anyOf: - - type: integer - - type: 'null' - updated_timestamp: - anyOf: - - type: integer - - type: 'null' - chunk_window: - anyOf: - - type: string - - type: 'null' - chunk_tokenizer: - anyOf: - - type: string - - type: 'null' - chunk_embedding_model: - anyOf: - - type: string - - type: 'null' - chunk_embedding_dimension: - anyOf: - - type: integer - - type: 'null' - content_token_count: - anyOf: - - type: integer - - type: 'null' - metadata_token_count: - anyOf: - - type: integer - - type: 'null' - type: object - title: ChunkMetadata - description: |- - `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that - will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` - is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. - Use `Chunk.metadata` for metadata that will be used in the context during inference. - CompletionInputType: - properties: - type: - type: string - const: completion_input - title: Type - default: completion_input - type: object - title: CompletionInputType - description: Parameter type for completion input. - Conversation: - properties: - id: - type: string - title: Id - description: The unique ID of the conversation. - object: - type: string - const: conversation - title: Object - description: The object type, which is always conversation. - default: conversation - created_at: - type: integer - title: Created At - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. - items: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - description: Initial items to include in the conversation context. You may add up to 20 items at a time. - type: object - required: - - id - - created_at - title: Conversation - description: OpenAI-compatible conversation object. - ConversationDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted conversation identifier - object: - type: string - title: Object - description: Object type - default: conversation.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationDeletedResource - description: Response for deleted conversation. - ConversationItemDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted item identifier - object: - type: string - title: Object - description: Object type - default: conversation.item.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationItemDeletedResource - description: Response for deleted conversation item. - ConversationItemInclude: - type: string - enum: - - web_search_call.action.sources - - code_interpreter_call.outputs - - computer_call_output.output.image_url - - file_search_call.results - - message.input_image.image_url - - message.output_text.logprobs - - reasoning.encrypted_content - title: ConversationItemInclude - description: Specify additional output data to include in the model response. - ConversationItemList: - properties: - object: - type: string - title: Object - description: Object type - default: list - data: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (9 variants) - type: array - title: Data - description: List of conversation items - first_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the first item in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the last item in the list - has_more: - type: boolean - title: Has More - description: Whether there are more items available - default: false - type: object - required: - - data - title: ConversationItemList - description: List of conversation items with pagination. - DPOAlignmentConfig: - properties: - beta: - type: number - title: Beta - loss_type: - $ref: '#/components/schemas/DPOLossType' - default: sigmoid - type: object - required: - - beta - title: DPOAlignmentConfig - description: Configuration for Direct Preference Optimization (DPO) alignment. - DPOLossType: - type: string - enum: - - sigmoid - - hinge - - ipo - - kto_pair - title: DPOLossType - DataConfig: - properties: - dataset_id: - type: string - title: Dataset Id - batch_size: - type: integer - title: Batch Size - shuffle: - type: boolean - title: Shuffle - data_format: - $ref: '#/components/schemas/DatasetFormat' - validation_dataset_id: - anyOf: - - type: string - - type: 'null' - packed: - anyOf: - - type: boolean - - type: 'null' - default: false - train_on_input: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - dataset_id - - batch_size - - shuffle - - data_format - title: DataConfig - description: Configuration for training data and data loading. - Dataset: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: dataset - title: Type - default: dataset - purpose: - $ref: '#/components/schemas/DatasetPurpose' - source: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource - discriminator: - propertyName: type - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this dataset - type: object - required: - - identifier - - provider_id - - purpose - - source - title: Dataset - description: Dataset resource for storing and accessing training or evaluation data. - DatasetFormat: - type: string - enum: - - instruct - - dialog - title: DatasetFormat - description: Format of the training dataset. - DatasetPurpose: - type: string - enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - title: DatasetPurpose - description: Purpose of the dataset. Each purpose has a required input data schema. - EfficiencyConfig: - properties: - enable_activation_checkpointing: - anyOf: - - type: boolean - - type: 'null' - default: false - enable_activation_offloading: - anyOf: - - type: boolean - - type: 'null' - default: false - memory_efficient_fsdp_wrap: - anyOf: - - type: boolean - - type: 'null' - default: false - fsdp_cpu_offload: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - title: EfficiencyConfig - description: Configuration for memory and compute efficiency optimizations. - Errors: - properties: - data: - anyOf: - - items: - $ref: '#/components/schemas/BatchError' - type: array - - type: 'null' - object: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: Errors - EvaluateResponse: - properties: - generations: - items: - additionalProperties: true - type: object - type: array - title: Generations - scores: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Scores - type: object - required: - - generations - - scores - title: EvaluateResponse - description: The response from an evaluation. - ExpiresAfter: - properties: - anchor: - type: string - const: created_at - title: Anchor - seconds: - type: integer - maximum: 2592000.0 - minimum: 3600.0 - title: Seconds - type: object - required: - - anchor - - seconds - title: ExpiresAfter - description: |- - Control expiration of uploaded files. - - Params: - - anchor, must be "created_at" - - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) - GreedySamplingStrategy: - properties: - type: - type: string - const: greedy - title: Type - default: greedy - type: object - title: GreedySamplingStrategy - description: Greedy sampling strategy that selects the highest probability token at each step. - HealthInfo: - properties: - status: - $ref: '#/components/schemas/HealthStatus' - type: object - required: - - status - title: HealthInfo - description: Health status information for the service. - HealthStatus: - type: string - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - ImageContentItem-Input: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - ImageContentItem-Output: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - InputTokensDetails: - properties: - cached_tokens: - type: integer - title: Cached Tokens - additionalProperties: true - type: object - required: - - cached_tokens - title: InputTokensDetails - Job: - properties: - job_id: - type: string - title: Job Id - status: - $ref: '#/components/schemas/JobStatus' - type: object - required: - - job_id - - status - title: Job - description: A job execution instance with status tracking. - JobStatus: - type: string - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - description: Status of a job execution. - JsonType: - properties: - type: - type: string - const: json - title: Type - default: json - type: object - title: JsonType - description: Parameter type for JSON values. - LLMAsJudgeScoringFnParams: - properties: - type: - type: string - const: llm_as_judge - title: Type - default: llm_as_judge - judge_model: - type: string - title: Judge Model - prompt_template: - anyOf: - - type: string - - type: 'null' - judge_score_regexes: - items: - type: string - type: array - title: Judge Score Regexes - description: Regexes to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - required: - - judge_model - title: LLMAsJudgeScoringFnParams - description: Parameters for LLM-as-judge scoring function configuration. - ListBatchesResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/Batch' - type: array - title: Data - description: List of batch objects - first_id: - anyOf: - - type: string - - type: 'null' - description: ID of the first batch in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: ID of the last batch in the list - has_more: - type: boolean - title: Has More - description: Whether there are more batches available - default: false - type: object - required: - - data - title: ListBatchesResponse - description: Response containing a list of batch objects. - ListBenchmarksResponse: - properties: - data: - items: - $ref: '#/components/schemas/Benchmark' - type: array - title: Data - type: object - required: - - data - title: ListBenchmarksResponse - ListDatasetsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Dataset' - type: array - title: Data - type: object - required: - - data - title: ListDatasetsResponse - description: Response from listing datasets. - ListOpenAIChatCompletionResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIChatCompletionResponse - description: Response from listing OpenAI-compatible chat completions. - ListOpenAIFileResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIFileObject' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIFileResponse - description: Response for listing files in OpenAI Files API. - ListOpenAIResponseInputItem: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Data - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - title: ListOpenAIResponseInputItem - description: List container for OpenAI response input items. - ListOpenAIResponseObject: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseObjectWithInput-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIResponseObject - description: Paginated list of OpenAI response objects with navigation metadata. - ListPostTrainingJobsResponse: - properties: - data: - items: - $ref: '#/components/schemas/PostTrainingJob' - type: array - title: Data - type: object - required: - - data - title: ListPostTrainingJobsResponse - ListPromptsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Prompt' - type: array - title: Data - type: object - required: - - data - title: ListPromptsResponse - description: Response model to list prompts. - ListProvidersResponse: - properties: - data: - items: - $ref: '#/components/schemas/ProviderInfo' - type: array - title: Data - type: object - required: - - data - title: ListProvidersResponse - description: Response containing a list of all available providers. - ListRoutesResponse: - properties: - data: - items: - $ref: '#/components/schemas/RouteInfo' - type: array - title: Data - type: object - required: - - data - title: ListRoutesResponse - description: Response containing a list of all available API routes. - ListScoringFunctionsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ScoringFn' - type: array - title: Data - type: object - required: - - data - title: ListScoringFunctionsResponse - ListShieldsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Shield' - type: array - title: Data - type: object - required: - - data - title: ListShieldsResponse - ListToolDefsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolDef' - type: array - title: Data - type: object - required: - - data - title: ListToolDefsResponse - description: Response containing a list of tool definitions. - ListToolGroupsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolGroup' - type: array - title: Data - type: object - required: - - data - title: ListToolGroupsResponse - description: Response containing a list of tool groups. - LoraFinetuningConfig: - properties: - type: - type: string - const: LoRA - title: Type - default: LoRA - lora_attn_modules: - items: - type: string - type: array - title: Lora Attn Modules - apply_lora_to_mlp: - type: boolean - title: Apply Lora To Mlp - apply_lora_to_output: - type: boolean - title: Apply Lora To Output - rank: - type: integer - title: Rank - alpha: - type: integer - title: Alpha - use_dora: - anyOf: - - type: boolean - - type: 'null' - default: false - quantize_base: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - title: LoraFinetuningConfig - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. - MCPListToolsTool: - properties: - input_schema: - additionalProperties: true - type: object - title: Input Schema - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_schema - - name - title: MCPListToolsTool - description: Tool definition returned by MCP list tools operation. - Model: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: model - title: Type - default: model - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this model - model_type: - $ref: '#/components/schemas/ModelType' - default: llm - type: object - required: - - identifier - - provider_id - title: Model - description: A model resource representing an AI model registered in Llama Stack. - ModelCandidate: - properties: - type: - type: string - const: model - title: Type - default: model - model: - type: string - title: Model - sampling_params: - $ref: '#/components/schemas/SamplingParams' - system_message: - anyOf: - - $ref: '#/components/schemas/SystemMessage' - title: SystemMessage - - type: 'null' - title: SystemMessage - type: object - required: - - model - - sampling_params - title: ModelCandidate - description: A model candidate for evaluation. - ModelType: - type: string - enum: - - llm - - embedding - - rerank - title: ModelType - description: Enumeration of supported model types in Llama Stack. - ModerationObject: - properties: - id: - type: string - title: Id - model: - type: string - title: Model - results: - items: - $ref: '#/components/schemas/ModerationObjectResults' - type: array - title: Results - type: object - required: - - id - - model - - results - title: ModerationObject - description: A moderation object. - ModerationObjectResults: - properties: - flagged: - type: boolean - title: Flagged - categories: - anyOf: - - additionalProperties: - type: boolean - type: object - - type: 'null' - category_applied_input_types: - anyOf: - - additionalProperties: - items: - type: string - type: array - type: object - - type: 'null' - category_scores: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - flagged - title: ModerationObjectResults - description: A moderation object. - NumberType: - properties: - type: - type: string - const: number - title: Type - default: number - type: object - title: NumberType - description: Parameter type for numeric values. - ObjectType: - properties: - type: - type: string - const: object - title: Type - default: object - type: object - title: ObjectType - description: Parameter type for object values. - OpenAIAssistantMessageParam-Input: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIAssistantMessageParam-Output: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIChatCompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - type: object - required: - - id - - choices - - created - - model - title: OpenAIChatCompletion - description: Response from an OpenAI-compatible chat completion request. - OpenAIChatCompletionContentPartImageParam: - properties: - type: - type: string - const: image_url - title: Type - default: image_url - image_url: - $ref: '#/components/schemas/OpenAIImageURL' - type: object - required: - - image_url - title: OpenAIChatCompletionContentPartImageParam - description: Image content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionContentPartTextParam: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: OpenAIChatCompletionContentPartTextParam - description: Text content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' - title: OpenAIAssistantMessageParam-Input - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input | ... (5 variants) - type: array - minItems: 1 - title: Messages - frequency_penalty: - anyOf: - - type: number - - type: 'null' - function_call: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - functions: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_completion_tokens: - anyOf: - - type: integer - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - response_format: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - title: OpenAIResponseFormatJSONSchema - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' - title: OpenAIResponseFormatJSONObject - discriminator: - propertyName: type - mapping: - json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' - json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' - text: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - - type: 'null' - title: Response Format - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - tool_choice: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - tools: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - top_logprobs: - anyOf: - - type: integer - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - messages - title: OpenAIChatCompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible chat completion endpoint. - OpenAIChatCompletionToolCall: - properties: - index: - anyOf: - - type: integer - - type: 'null' - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - const: function - title: Type - default: function - function: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' - title: OpenAIChatCompletionToolCallFunction - - type: 'null' - title: OpenAIChatCompletionToolCallFunction - type: object - title: OpenAIChatCompletionToolCall - description: Tool call specification for OpenAI-compatible chat completion responses. - OpenAIChatCompletionToolCallFunction: - properties: - name: - anyOf: - - type: string - - type: 'null' - arguments: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIChatCompletionToolCallFunction - description: Function call details for OpenAI-compatible tool calls. - OpenAIChatCompletionUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - completion_tokens: - type: integer - title: Completion Tokens - total_tokens: - type: integer - title: Total Tokens - prompt_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' - title: OpenAIChatCompletionUsagePromptTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsagePromptTokensDetails - completion_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' - title: OpenAIChatCompletionUsageCompletionTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsageCompletionTokensDetails - type: object - required: - - prompt_tokens - - completion_tokens - - total_tokens - title: OpenAIChatCompletionUsage - description: Usage information for OpenAI chat completion. - OpenAIChatCompletionUsageCompletionTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsageCompletionTokensDetails - description: Token details for output tokens in OpenAI chat completion usage. - OpenAIChatCompletionUsagePromptTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsagePromptTokensDetails - description: Token details for prompt tokens in OpenAI chat completion usage. - OpenAIChoice-Input: - properties: - message: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' - title: OpenAIAssistantMessageParam-Input - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam-Input | ... (5 variants) - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Input' - finish_reason: - type: string - title: Finish Reason - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Input' - title: OpenAIChoiceLogprobs-Input - - type: 'null' - title: OpenAIChoiceLogprobs-Input - type: object - required: - - message - - finish_reason - - index - title: OpenAIChoice - description: A choice from an OpenAI-compatible chat completion response. - OpenAIChoice-Output: - properties: - message: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam-Output | ... (5 variants) - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - finish_reason: - type: string - title: Finish Reason - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - message - - finish_reason - - index - title: OpenAIChoice - description: A choice from an OpenAI-compatible chat completion response. - OpenAIChoiceLogprobs-Input: - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - type: object - title: OpenAIChoiceLogprobs - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - OpenAIChoiceLogprobs-Output: - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - type: object - title: OpenAIChoiceLogprobs - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - OpenAICompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAICompletionChoice-Output' - type: array - title: Choices - created: - type: integer - title: Created - model: - type: string - title: Model - object: - type: string - const: text_completion - title: Object - default: text_completion - type: object - required: - - id - - choices - - created - - model - title: OpenAICompletion - description: |- - Response from an OpenAI-compatible completion request. - - :id: The ID of the completion - :choices: List of choices - :created: The Unix timestamp in seconds when the completion was created - :model: The model that was used to generate the completion - :object: The object type, which will be "text_completion" - OpenAICompletionChoice-Input: - properties: - finish_reason: - type: string - title: Finish Reason - text: - type: string - title: Text - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Input' - title: OpenAIChoiceLogprobs-Input - - type: 'null' - title: OpenAIChoiceLogprobs-Input - type: object - required: - - finish_reason - - text - - index - title: OpenAICompletionChoice - description: |- - A choice from an OpenAI-compatible completion response. - - :finish_reason: The reason the model stopped generating - :text: The text of the choice - :index: The index of the choice - :logprobs: (Optional) The log probabilities for the tokens in the choice - OpenAICompletionChoice-Output: - properties: - finish_reason: - type: string - title: Finish Reason - text: - type: string - title: Text - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - finish_reason - - text - - index - title: OpenAICompletionChoice - description: |- - A choice from an OpenAI-compatible completion response. - - :finish_reason: The reason the model stopped generating - :text: The text of the choice - :index: The index of the choice - :logprobs: (Optional) The log probabilities for the tokens in the choice - OpenAICompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - prompt: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - items: - type: integer - type: array - title: list[integer] - - items: - items: - type: integer - type: array - type: array - title: list[array] - title: string | ... (4 variants) - best_of: - anyOf: - - type: integer - - type: 'null' - echo: - anyOf: - - type: boolean - - type: 'null' - frequency_penalty: - anyOf: - - type: number - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - suffix: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - prompt - title: OpenAICompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible completion endpoint. - OpenAICompletionWithInputMessages: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - input_messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output | ... (5 variants) - type: array - title: Input Messages - type: object - required: - - id - - choices - - created - - model - - input_messages - title: OpenAICompletionWithInputMessages - OpenAICreateVectorStoreFileBatchRequestWithExtraBody: - properties: - file_ids: - items: - type: string - type: array - title: File Ids - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - additionalProperties: true - type: object - required: - - file_ids - title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: Request to create a vector store file batch with extra_body support. - OpenAICreateVectorStoreRequestWithExtraBody: - properties: - name: - anyOf: - - type: string - - type: 'null' - file_ids: - anyOf: - - items: - type: string - type: array - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - additionalProperties: true - type: object - title: OpenAICreateVectorStoreRequestWithExtraBody - description: Request to create a vector store with extra_body support. - OpenAIDeleteResponseObject: - properties: - id: - type: string - title: Id - object: - type: string - const: response - title: Object - default: response - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: OpenAIDeleteResponseObject - description: Response object confirming deletion of an OpenAI response. - OpenAIDeveloperMessageParam: - properties: - role: - type: string - const: developer - title: Role - default: developer - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIDeveloperMessageParam - description: A message from the developer in an OpenAI-compatible chat completion request. - OpenAIEmbeddingData: - properties: - object: - type: string - const: embedding - title: Object - default: embedding - embedding: - anyOf: - - items: - type: number - type: array - title: list[number] - - type: string - title: list[number] | string - index: - type: integer - title: Index - type: object - required: - - embedding - - index - title: OpenAIEmbeddingData - description: A single embedding data object from an OpenAI-compatible embeddings response. - OpenAIEmbeddingUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - total_tokens: - type: integer - title: Total Tokens - type: object - required: - - prompt_tokens - - total_tokens - title: OpenAIEmbeddingUsage - description: Usage information for an OpenAI-compatible embeddings response. - OpenAIEmbeddingsRequestWithExtraBody: - properties: - model: - type: string - title: Model - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - encoding_format: - anyOf: - - type: string - - type: 'null' - default: float - dimensions: - anyOf: - - type: integer - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - input - title: OpenAIEmbeddingsRequestWithExtraBody - description: Request parameters for OpenAI-compatible embeddings endpoint. - OpenAIEmbeddingsResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/OpenAIEmbeddingData' - type: array - title: Data - model: - type: string - title: Model - usage: - $ref: '#/components/schemas/OpenAIEmbeddingUsage' - type: object - required: - - data - - model - - usage - title: OpenAIEmbeddingsResponse - description: Response from an OpenAI-compatible embeddings request. - OpenAIFile: - properties: - type: - type: string - const: file - title: Type - default: file - file: - $ref: '#/components/schemas/OpenAIFileFile' - type: object - required: - - file - title: OpenAIFile - OpenAIFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - const: file - title: Object - default: file - deleted: - type: boolean - title: Deleted - type: object - required: - - id - - deleted - title: OpenAIFileDeleteResponse - description: Response for deleting a file in OpenAI Files API. - OpenAIFileFile: - properties: - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIFileFile - OpenAIFileObject: - properties: - object: - type: string - const: file - title: Object - default: file - id: - type: string - title: Id - bytes: - type: integer - title: Bytes - created_at: - type: integer - title: Created At - expires_at: - type: integer - title: Expires At - filename: - type: string - title: Filename - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - type: object - required: - - id - - bytes - - created_at - - expires_at - - filename - - purpose - title: OpenAIFileObject - description: OpenAI File object as defined in the OpenAI Files API. - OpenAIFilePurpose: - type: string - enum: - - assistants - - batch - title: OpenAIFilePurpose - description: Valid purpose values for OpenAI Files API. - OpenAIImageURL: - properties: - url: - type: string - title: Url - detail: - anyOf: - - type: string - - type: 'null' - type: object - required: - - url - title: OpenAIImageURL - description: Image URL specification for OpenAI-compatible chat completion messages. - OpenAIJSONSchema: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: OpenAIJSONSchema - description: JSON schema specification for OpenAI-compatible structured response format. - OpenAIListModelsResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIModel' - type: array - title: Data - type: object - required: - - data - title: OpenAIListModelsResponse - OpenAIModel: - properties: - id: - type: string - title: Id - object: - type: string - const: model - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - custom_metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - id - - created - - owned_by - title: OpenAIModel - description: |- - A model from OpenAI. - - :id: The ID of the model - :object: The object type, which will be "model" - :created: The Unix timestamp in seconds when the model was created - :owned_by: The owner of the model - :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata - OpenAIResponseAnnotationCitation: - properties: - type: - type: string - const: url_citation - title: Type - default: url_citation - end_index: - type: integer - title: End Index - start_index: - type: integer - title: Start Index - title: - type: string - title: Title - url: - type: string - title: Url - type: object - required: - - end_index - - start_index - - title - - url - title: OpenAIResponseAnnotationCitation - description: URL citation annotation for referencing external web resources. - OpenAIResponseAnnotationContainerFileCitation: - properties: - type: - type: string - const: container_file_citation - title: Type - default: container_file_citation - container_id: - type: string - title: Container Id - end_index: - type: integer - title: End Index - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - start_index: - type: integer - title: Start Index - type: object - required: - - container_id - - end_index - - file_id - - filename - - start_index - title: OpenAIResponseAnnotationContainerFileCitation - OpenAIResponseAnnotationFileCitation: - properties: - type: - type: string - const: file_citation - title: Type - default: file_citation - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - index: - type: integer - title: Index - type: object - required: - - file_id - - filename - - index - title: OpenAIResponseAnnotationFileCitation - description: File citation annotation for referencing specific files in response content. - OpenAIResponseAnnotationFilePath: - properties: - type: - type: string - const: file_path - title: Type - default: file_path - file_id: - type: string - title: File Id - index: - type: integer - title: Index - type: object - required: - - file_id - - index - title: OpenAIResponseAnnotationFilePath - OpenAIResponseContentPartRefusal: - properties: - type: - type: string - const: refusal - title: Type - default: refusal - refusal: - type: string - title: Refusal - type: object - required: - - refusal - title: OpenAIResponseContentPartRefusal - description: Refusal content within a streamed response part. - OpenAIResponseError: - properties: - code: - type: string - title: Code - message: - type: string - title: Message - type: object - required: - - code - - message - title: OpenAIResponseError - description: Error details for failed OpenAI response requests. - OpenAIResponseFormatJSONObject: - properties: - type: - type: string - const: json_object - title: Type - default: json_object - type: object - title: OpenAIResponseFormatJSONObject - description: JSON object response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatJSONSchema: - properties: - type: - type: string - const: json_schema - title: Type - default: json_schema - json_schema: - $ref: '#/components/schemas/OpenAIJSONSchema' - type: object - required: - - json_schema - title: OpenAIResponseFormatJSONSchema - description: JSON schema response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatText: - properties: - type: - type: string - const: text - title: Type - default: text - type: object - title: OpenAIResponseFormatText - description: Text response format for OpenAI-compatible chat completion requests. - OpenAIResponseInputFunctionToolCallOutput: - properties: - call_id: - type: string - title: Call Id - output: - type: string - title: Output - type: - type: string - const: function_call_output - title: Type - default: function_call_output - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - output - title: OpenAIResponseInputFunctionToolCallOutput - description: This represents the output of a function call that gets passed back to the model. - OpenAIResponseInputMessageContentFile: - properties: - type: - type: string - const: input_file - title: Type - default: input_file - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - file_url: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentFile - description: File content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentImage: - properties: - detail: - title: Detail - default: auto - type: string - enum: - - low - - high - - auto - type: - type: string - const: input_image - title: Type - default: input_image - file_id: - anyOf: - - type: string - - type: 'null' - image_url: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentImage - description: Image content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentText: - properties: - text: - type: string - title: Text - type: - type: string - const: input_text - title: Type - default: input_text - type: object - required: - - text - title: OpenAIResponseInputMessageContentText - description: Text content for input messages in OpenAI response format. - OpenAIResponseInputToolFileSearch: - properties: - type: - type: string - const: file_search - title: Type - default: file_search - vector_store_ids: - items: - type: string - type: array - title: Vector Store Ids - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - maximum: 50.0 - minimum: 1.0 - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - type: object - required: - - vector_store_ids - title: OpenAIResponseInputToolFileSearch - description: File search tool configuration for OpenAI response inputs. - OpenAIResponseInputToolFunction: - properties: - type: - type: string - const: function - title: Type - default: function - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - required: - - name - - parameters - title: OpenAIResponseInputToolFunction - description: Function tool configuration for OpenAI response inputs. - OpenAIResponseInputToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - server_url: - type: string - title: Server Url - headers: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - require_approval: - anyOf: - - type: string - const: always - - type: string - const: never - - $ref: '#/components/schemas/ApprovalFilter' - title: ApprovalFilter - title: string | ApprovalFilter - default: never - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - - server_url - title: OpenAIResponseInputToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. - OpenAIResponseInputToolWebSearch: - properties: - type: - title: Type - default: web_search - type: string - enum: - - web_search - - web_search_preview - - web_search_preview_2025_03_11 - - web_search_2025_08_26 - search_context_size: - anyOf: - - type: string - pattern: ^low|medium|high$ - - type: 'null' - default: medium - type: object - title: OpenAIResponseInputToolWebSearch - description: Web search tool configuration for OpenAI response inputs. - OpenAIResponseMCPApprovalRequest: - properties: - arguments: - type: string - title: Arguments - id: - type: string - title: Id - name: - type: string - title: Name - server_label: - type: string - title: Server Label - type: - type: string - const: mcp_approval_request - title: Type - default: mcp_approval_request - type: object - required: - - arguments - - id - - name - - server_label - title: OpenAIResponseMCPApprovalRequest - description: A request for human approval of a tool invocation. - OpenAIResponseMCPApprovalResponse: - properties: - approval_request_id: - type: string - title: Approval Request Id - approve: - type: boolean - title: Approve - type: - type: string - const: mcp_approval_response - title: Type - default: mcp_approval_response - id: - anyOf: - - type: string - - type: 'null' - reason: - anyOf: - - type: string - - type: 'null' - type: object - required: - - approval_request_id - - approve - title: OpenAIResponseMCPApprovalResponse - description: A response to an MCP approval request. - OpenAIResponseMessage-Input: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseMessage-Output: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseObject: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - created_at - - id - - model - - output - - status - title: OpenAIResponseObject - description: Complete OpenAI response object containing generation results and metadata. - OpenAIResponseObjectWithInput-Input: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - input: - items: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input - type: array - title: Input - type: object - required: - - created_at - - id - - model - - output - - status - - input - title: OpenAIResponseObjectWithInput - description: OpenAI response object extended with input context information. - OpenAIResponseObjectWithInput-Output: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - input: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Input - type: object - required: - - created_at - - id - - model - - output - - status - - input - title: OpenAIResponseObjectWithInput - description: OpenAI response object extended with input context information. - OpenAIResponseOutputMessageContentOutputText: - properties: - text: - type: string - title: Text - type: - type: string - const: output_text - title: Type - default: output_text - annotations: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - title: OpenAIResponseAnnotationFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - title: OpenAIResponseAnnotationContainerFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - title: OpenAIResponseAnnotationFilePath - discriminator: - propertyName: type - mapping: - container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' - url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - type: array - title: Annotations - type: object - required: - - text - title: OpenAIResponseOutputMessageContentOutputText - OpenAIResponseOutputMessageFileSearchToolCall: - properties: - id: - type: string - title: Id - queries: - items: - type: string - type: array - title: Queries - status: - type: string - title: Status - type: - type: string - const: file_search_call - title: Type - default: file_search_call - results: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' - type: array - - type: 'null' - type: object - required: - - id - - queries - - status - title: OpenAIResponseOutputMessageFileSearchToolCall - description: File search tool call output message for OpenAI responses. - OpenAIResponseOutputMessageFileSearchToolCallResults: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - text: - type: string - title: Text - type: object - required: - - attributes - - file_id - - filename - - score - - text - title: OpenAIResponseOutputMessageFileSearchToolCallResults - description: Search results returned by the file search operation. - OpenAIResponseOutputMessageFunctionToolCall: - properties: - call_id: - type: string - title: Call Id - name: - type: string - title: Name - arguments: - type: string - title: Arguments - type: - type: string - const: function_call - title: Type - default: function_call - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - name - - arguments - title: OpenAIResponseOutputMessageFunctionToolCall - description: Function tool call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPCall: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_call - title: Type - default: mcp_call - arguments: - type: string - title: Arguments - name: - type: string - title: Name - server_label: - type: string - title: Server Label - error: - anyOf: - - type: string - - type: 'null' - output: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - - arguments - - name - - server_label - title: OpenAIResponseOutputMessageMCPCall - description: Model Context Protocol (MCP) call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPListTools: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_list_tools - title: Type - default: mcp_list_tools - server_label: - type: string - title: Server Label - tools: - items: - $ref: '#/components/schemas/MCPListToolsTool' - type: array - title: Tools - type: object - required: - - id - - server_label - - tools - title: OpenAIResponseOutputMessageMCPListTools - description: MCP list tools output message containing available tools from an MCP server. - OpenAIResponseOutputMessageWebSearchToolCall: - properties: - id: - type: string - title: Id - status: - type: string - title: Status - type: - type: string - const: web_search_call - title: Type - default: web_search_call - type: object - required: - - id - - status - title: OpenAIResponseOutputMessageWebSearchToolCall - description: Web search tool call output message for OpenAI responses. - OpenAIResponsePrompt: - properties: - id: - type: string - title: Id - variables: - anyOf: - - additionalProperties: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: object - - type: 'null' - version: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - title: OpenAIResponsePrompt - description: OpenAI compatible Prompt object that is used in OpenAI responses. - OpenAIResponseText: - properties: - format: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseTextFormat' - title: OpenAIResponseTextFormat - - type: 'null' - title: OpenAIResponseTextFormat - type: object - title: OpenAIResponseText - description: Text response configuration for OpenAI responses. - OpenAIResponseTextFormat: - properties: - type: - title: Type - type: string - enum: - - text - - json_schema - - json_object - default: text - name: - anyOf: - - type: string - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - title: OpenAIResponseTextFormat - description: Configuration for Responses API text format. - OpenAIResponseToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - title: OpenAIResponseToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. - OpenAIResponseUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - output_tokens: - type: integer - title: Output Tokens - total_tokens: - type: integer - title: Total Tokens - input_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' - title: OpenAIResponseUsageInputTokensDetails - - type: 'null' - title: OpenAIResponseUsageInputTokensDetails - output_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' - title: OpenAIResponseUsageOutputTokensDetails - - type: 'null' - title: OpenAIResponseUsageOutputTokensDetails - type: object - required: - - input_tokens - - output_tokens - - total_tokens - title: OpenAIResponseUsage - description: Usage information for OpenAI response. - OpenAIResponseUsageInputTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageInputTokensDetails - description: Token details for input tokens in OpenAI response usage. - OpenAIResponseUsageOutputTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageOutputTokensDetails - description: Token details for output tokens in OpenAI response usage. - OpenAISystemMessageParam: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAISystemMessageParam - description: A system message providing instructions or context to the model. - OpenAITokenLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - top_logprobs: - items: - $ref: '#/components/schemas/OpenAITopLogProb' - type: array - title: Top Logprobs - type: object - required: - - token - - logprob - - top_logprobs - title: OpenAITokenLogProb - description: |- - The log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - :top_logprobs: The top log probabilities for the token - OpenAIToolMessageParam: - properties: - role: - type: string - const: tool - title: Role - default: tool - tool_call_id: - type: string - title: Tool Call Id - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - type: object - required: - - tool_call_id - - content - title: OpenAIToolMessageParam - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. - OpenAITopLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - type: object - required: - - token - - logprob - title: OpenAITopLogProb - description: |- - The top log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - OpenAIUserMessageParam-Input: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OpenAIUserMessageParam-Output: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OptimizerConfig: - properties: - optimizer_type: - $ref: '#/components/schemas/OptimizerType' - lr: - type: number - title: Lr - weight_decay: - type: number - title: Weight Decay - num_warmup_steps: - type: integer - title: Num Warmup Steps - type: object - required: - - optimizer_type - - lr - - weight_decay - - num_warmup_steps - title: OptimizerConfig - description: Configuration parameters for the optimization algorithm. - OptimizerType: - type: string - enum: - - adam - - adamw - - sgd - title: OptimizerType - description: Available optimizer algorithms for training. - Order: - type: string - enum: - - asc - - desc - title: Order - description: Sort order for paginated responses. - OutputTokensDetails: - properties: - reasoning_tokens: - type: integer - title: Reasoning Tokens - additionalProperties: true - type: object - required: - - reasoning_tokens - title: OutputTokensDetails - PaginatedResponse: - properties: - data: - items: - additionalProperties: true - type: object - type: array - title: Data - has_more: - type: boolean - title: Has More - url: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - - has_more - title: PaginatedResponse - description: A generic paginated response that follows a simple format. - PostTrainingJob: - properties: - job_uuid: - type: string - title: Job Uuid - type: object - required: - - job_uuid - title: PostTrainingJob - PostTrainingJobArtifactsResponse: - properties: - job_uuid: - type: string - title: Job Uuid - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - title: PostTrainingJobArtifactsResponse - description: Artifacts of a finetuning job. - PostTrainingJobStatusResponse: - properties: - job_uuid: - type: string - title: Job Uuid - status: - $ref: '#/components/schemas/JobStatus' - scheduled_at: - anyOf: - - type: string - format: date-time - - type: 'null' - started_at: - anyOf: - - type: string - format: date-time - - type: 'null' - completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' - resources_allocated: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - - status - title: PostTrainingJobStatusResponse - description: Status of a finetuning job. - PostTrainingMetric: - properties: - epoch: - type: integer - title: Epoch - train_loss: - type: number - title: Train Loss - validation_loss: - type: number - title: Validation Loss - perplexity: - type: number - title: Perplexity - type: object - required: - - epoch - - train_loss - - validation_loss - - perplexity - title: PostTrainingMetric - description: Training metrics captured during post-training jobs. - Prompt: - properties: - prompt: - anyOf: - - type: string - - type: 'null' - description: The system prompt with variable placeholders - version: - type: integer - minimum: 1.0 - title: Version - description: Version (integer starting at 1, incremented on save) - prompt_id: - type: string - title: Prompt Id - description: Unique identifier in format 'pmpt_<48-digit-hash>' - variables: - items: - type: string - type: array - title: Variables - description: List of variable names that can be used in the prompt template - is_default: - type: boolean - title: Is Default - description: Boolean indicating whether this version is the default version - default: false - type: object - required: - - version - - prompt_id - title: Prompt - description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. - ProviderInfo: - properties: - api: - type: string - title: Api - provider_id: - type: string - title: Provider Id - provider_type: - type: string - title: Provider Type - config: - additionalProperties: true - type: object - title: Config - health: - additionalProperties: true - type: object - title: Health - type: object - required: - - api - - provider_id - - provider_type - - config - - health - title: ProviderInfo - description: Information about a registered provider including its configuration and health status. - QATFinetuningConfig: - properties: - type: - type: string - const: QAT - title: Type - default: QAT - quantizer_name: - type: string - title: Quantizer Name - group_size: - type: integer - title: Group Size - type: object - required: - - quantizer_name - - group_size - title: QATFinetuningConfig - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. - QueryChunksResponse: - properties: - chunks: - items: - $ref: '#/components/schemas/Chunk-Output' - type: array - title: Chunks - scores: - items: - type: number - type: array - title: Scores - type: object - required: - - chunks - - scores - title: QueryChunksResponse - description: Response from querying chunks in a vector database. - RegexParserScoringFnParams: - properties: - type: - type: string - const: regex_parser - title: Type - default: regex_parser - parsing_regexes: - items: - type: string - type: array - title: Parsing Regexes - description: Regex to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: RegexParserScoringFnParams - description: Parameters for regex parser scoring function configuration. - RerankData: - properties: - index: - type: integer - title: Index - relevance_score: - type: number - title: Relevance Score - type: object - required: - - index - - relevance_score - title: RerankData - description: A single rerank result from a reranking response. - RerankResponse: - properties: - data: - items: - $ref: '#/components/schemas/RerankData' - type: array - title: Data - type: object - required: - - data - title: RerankResponse - description: Response from a reranking request. - RouteInfo: - properties: - route: - type: string - title: Route - method: - type: string - title: Method - provider_types: - items: - type: string - type: array - title: Provider Types - type: object - required: - - route - - method - - provider_types - title: RouteInfo - description: Information about an API route including its path, method, and implementing providers. - RowsDataSource: - properties: - type: - type: string - const: rows - title: Type - default: rows - rows: - items: - additionalProperties: true - type: object - type: array - title: Rows - type: object - required: - - rows - title: RowsDataSource - description: A dataset stored in rows. - RunShieldResponse: - properties: - violation: - anyOf: - - $ref: '#/components/schemas/SafetyViolation' - title: SafetyViolation - - type: 'null' - title: SafetyViolation - type: object - title: RunShieldResponse - description: Response from running a safety shield. - SafetyViolation: - properties: - violation_level: - $ref: '#/components/schemas/ViolationLevel' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - violation_level - title: SafetyViolation - description: Details of a safety violation detected by content moderation. - SamplingParams: - properties: - strategy: - oneOf: - - $ref: '#/components/schemas/GreedySamplingStrategy' - title: GreedySamplingStrategy - - $ref: '#/components/schemas/TopPSamplingStrategy' - title: TopPSamplingStrategy - - $ref: '#/components/schemas/TopKSamplingStrategy' - title: TopKSamplingStrategy - title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy - discriminator: - propertyName: type - mapping: - greedy: '#/components/schemas/GreedySamplingStrategy' - top_k: '#/components/schemas/TopKSamplingStrategy' - top_p: '#/components/schemas/TopPSamplingStrategy' - max_tokens: - anyOf: - - type: integer - - type: 'null' - repetition_penalty: - anyOf: - - type: number - - type: 'null' - default: 1.0 - stop: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: SamplingParams - description: Sampling parameters. - ScoreBatchResponse: - properties: - dataset_id: - anyOf: - - type: string - - type: 'null' - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreBatchResponse - description: Response from batch scoring operations on datasets. - ScoreResponse: - properties: - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreResponse - description: The response from scoring. - ScoringFn: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: scoring_function - title: Type - default: scoring_function - description: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this definition - return_type: - oneOf: - - $ref: '#/components/schemas/StringType' - title: StringType - - $ref: '#/components/schemas/NumberType' - title: NumberType - - $ref: '#/components/schemas/BooleanType' - title: BooleanType - - $ref: '#/components/schemas/ArrayType' - title: ArrayType - - $ref: '#/components/schemas/ObjectType' - title: ObjectType - - $ref: '#/components/schemas/JsonType' - title: JsonType - - $ref: '#/components/schemas/UnionType' - title: UnionType - - $ref: '#/components/schemas/ChatCompletionInputType' - title: ChatCompletionInputType - - $ref: '#/components/schemas/CompletionInputType' - title: CompletionInputType - title: StringType | ... (9 variants) - description: The return type of the deterministic function - discriminator: - propertyName: type - mapping: - array: '#/components/schemas/ArrayType' - boolean: '#/components/schemas/BooleanType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - json: '#/components/schemas/JsonType' - number: '#/components/schemas/NumberType' - object: '#/components/schemas/ObjectType' - string: '#/components/schemas/StringType' - union: '#/components/schemas/UnionType' - params: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: Params - description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval - type: object - required: - - identifier - - provider_id - - return_type - title: ScoringFn - description: A scoring function resource for evaluating model outputs. - ScoringResult: - properties: - score_rows: - items: - additionalProperties: true - type: object - type: array - title: Score Rows - aggregated_results: - additionalProperties: true - type: object - title: Aggregated Results - type: object - required: - - score_rows - - aggregated_results - title: ScoringResult - description: A scoring result for a single row. - SearchRankingOptions: - properties: - ranker: - anyOf: - - type: string - - type: 'null' - score_threshold: - anyOf: - - type: number - - type: 'null' - default: 0.0 - type: object - title: SearchRankingOptions - description: Options for ranking and filtering search results. - Shield: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: shield - title: Type - default: shield - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: Shield - description: A safety shield resource that can be used to check content. - StringType: - properties: - type: - type: string - const: string - title: Type - default: string - type: object - title: StringType - description: Parameter type for string values. - SystemMessage: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - type: object - required: - - content - title: SystemMessage - description: A system message providing instructions or context to the model. - TextContentItem: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: TextContentItem - description: A text content item - ToolDef: - properties: - toolgroup_id: - anyOf: - - type: string - - type: 'null' - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - input_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - output_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - name - title: ToolDef - description: Tool definition used in runtime contexts. - ToolGroup: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: tool_group - title: Type - default: tool_group - mcp_endpoint: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - args: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: ToolGroup - description: A group of related tools managed together. - ToolInvocationResult: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - - type: 'null' - title: string | list[ImageContentItem-Output | TextContentItem] - error_message: - anyOf: - - type: string - - type: 'null' - error_code: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: ToolInvocationResult - description: Result of a tool invocation. - TopKSamplingStrategy: - properties: - type: - type: string - const: top_k - title: Type - default: top_k - top_k: - type: integer - minimum: 1.0 - title: Top K - type: object - required: - - top_k - title: TopKSamplingStrategy - description: Top-k sampling strategy that restricts sampling to the k most likely tokens. - TopPSamplingStrategy: - properties: - type: - type: string - const: top_p - title: Type - default: top_p - temperature: - anyOf: - - type: number - minimum: 0.0 - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - default: 0.95 - type: object - required: - - temperature - title: TopPSamplingStrategy - description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. - TrainingConfig: - properties: - n_epochs: - type: integer - title: N Epochs - max_steps_per_epoch: - type: integer - title: Max Steps Per Epoch - default: 1 - gradient_accumulation_steps: - type: integer - title: Gradient Accumulation Steps - default: 1 - max_validation_steps: - anyOf: - - type: integer - - type: 'null' - default: 1 - data_config: - anyOf: - - $ref: '#/components/schemas/DataConfig' - title: DataConfig - - type: 'null' - title: DataConfig - optimizer_config: - anyOf: - - $ref: '#/components/schemas/OptimizerConfig' - title: OptimizerConfig - - type: 'null' - title: OptimizerConfig - efficiency_config: - anyOf: - - $ref: '#/components/schemas/EfficiencyConfig' - title: EfficiencyConfig - - type: 'null' - title: EfficiencyConfig - dtype: - anyOf: - - type: string - - type: 'null' - default: bf16 - type: object - required: - - n_epochs - title: TrainingConfig - description: Comprehensive configuration for the training process. - URIDataSource: - properties: - type: - type: string - const: uri - title: Type - default: uri - uri: - type: string - title: Uri - type: object - required: - - uri - title: URIDataSource - description: A dataset that can be obtained from a URI. - URL: - properties: - uri: - type: string - title: Uri - type: object - required: - - uri - title: URL - description: A URL reference to external content. - UnionType: - properties: - type: - type: string - const: union - title: Type - default: union - type: object - title: UnionType - description: Parameter type for union values. - VectorStoreChunkingStrategyAuto: - properties: - type: - type: string - const: auto - title: Type - default: auto - type: object - title: VectorStoreChunkingStrategyAuto - description: Automatic chunking strategy for vector store files. - VectorStoreChunkingStrategyStatic: - properties: - type: - type: string - const: static - title: Type - default: static - static: - $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - type: object - required: - - static - title: VectorStoreChunkingStrategyStatic - description: Static chunking strategy with configurable parameters. - VectorStoreChunkingStrategyStaticConfig: - properties: - chunk_overlap_tokens: - type: integer - title: Chunk Overlap Tokens - default: 400 - max_chunk_size_tokens: - type: integer - maximum: 4096.0 - minimum: 100.0 - title: Max Chunk Size Tokens - default: 800 - type: object - title: VectorStoreChunkingStrategyStaticConfig - description: Configuration for static chunking strategy. - VectorStoreContent: - properties: - type: - type: string - const: text - title: Type - text: - type: string - title: Text - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - type - - text - title: VectorStoreContent - description: Content item from a vector store file or search result. - VectorStoreDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreDeleteResponse - description: Response from deleting a vector store. - VectorStoreFileBatchObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file_batch - created_at: - type: integer - title: Created At - vector_store_id: - type: string - title: Vector Store Id - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - type: object - required: - - id - - created_at - - vector_store_id - - status - - file_counts - title: VectorStoreFileBatchObject - description: OpenAI Vector Store File Batch object. - VectorStoreFileContentResponse: - properties: - object: - type: string - const: vector_store.file_content.page - title: Object - default: vector_store.file_content.page - data: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - title: VectorStoreFileContentResponse - description: Represents the parsed content of a vector store file. - VectorStoreFileCounts: - properties: - completed: - type: integer - title: Completed - cancelled: - type: integer - title: Cancelled - failed: - type: integer - title: Failed - in_progress: - type: integer - title: In Progress - total: - type: integer - title: Total - type: object - required: - - completed - - cancelled - - failed - - in_progress - - total - title: VectorStoreFileCounts - description: File processing status counts for a vector store. - VectorStoreFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreFileDeleteResponse - description: Response from deleting a vector store file. - VectorStoreFileLastError: - properties: - code: - title: Code - type: string - enum: - - server_error - - rate_limit_exceeded - default: server_error - message: - type: string - title: Message - type: object - required: - - code - - message - title: VectorStoreFileLastError - description: Error information for failed vector store file processing. - VectorStoreFileObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file - attributes: - additionalProperties: true - type: object - title: Attributes - chunking_strategy: - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - created_at: - type: integer - title: Created At - last_error: - anyOf: - - $ref: '#/components/schemas/VectorStoreFileLastError' - title: VectorStoreFileLastError - - type: 'null' - title: VectorStoreFileLastError - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - vector_store_id: - type: string - title: Vector Store Id - type: object - required: - - id - - chunking_strategy - - created_at - - status - - vector_store_id - title: VectorStoreFileObject - description: OpenAI Vector Store File object. - VectorStoreFilesListInBatchResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreFilesListInBatchResponse - description: Response from listing files in a vector store file batch. - VectorStoreListFilesResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListFilesResponse - description: Response from listing files in a vector store. - VectorStoreListResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListResponse - description: Response from listing vector stores. - VectorStoreObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store - created_at: - type: integer - title: Created At - name: - anyOf: - - type: string - - type: 'null' - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - status: - type: string - title: Status - default: completed - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - last_active_at: - anyOf: - - type: integer - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - id - - created_at - - file_counts - title: VectorStoreObject - description: OpenAI Vector Store object. - VectorStoreSearchResponse-Input: - properties: - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - attributes: - anyOf: - - additionalProperties: - anyOf: - - type: string - - type: number - - type: boolean - title: string | number | boolean - type: object - - type: 'null' - content: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Content - type: object - required: - - file_id - - filename - - score - - content - title: VectorStoreSearchResponse - description: Response from searching a vector store. - VectorStoreSearchResponse-Output: - properties: - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - attributes: - anyOf: - - additionalProperties: - anyOf: - - type: string - - type: number - - type: boolean - title: string | number | boolean - type: object - - type: 'null' - content: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Content - type: object - required: - - file_id - - filename - - score - - content - title: VectorStoreSearchResponse - description: Response from searching a vector store. - VectorStoreSearchResponsePage: - properties: - object: - type: string - title: Object - default: vector_store.search_results.page - search_query: - items: - type: string - type: array - title: Search Query - data: - items: - $ref: '#/components/schemas/VectorStoreSearchResponse-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - search_query - - data - title: VectorStoreSearchResponsePage - description: Paginated response from searching a vector store. - VersionInfo: - properties: - version: - type: string - title: Version - type: object - required: - - version - title: VersionInfo - description: Version information for the service. - ViolationLevel: - type: string - enum: - - info - - warn - - error - title: ViolationLevel - description: Severity level of a safety violation. - _URLOrData: - properties: - url: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - data: - anyOf: - - type: string - - type: 'null' - contentEncoding: base64 - type: object - title: _URLOrData - description: A URL or a base64 encoded string - _batches_Request: - properties: - input_file_id: - type: string - title: Input File Id - endpoint: - type: string - title: Endpoint - completion_window: - type: string - const: 24h - title: Completion Window - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - idempotency_key: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_file_id - - endpoint - - completion_window - title: _batches_Request - _conversations_Request: - properties: - items: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - type: object - title: _conversations_Request - _conversations_conversation_id_Request: - properties: - metadata: - additionalProperties: - type: string - type: object - title: Metadata - type: object - required: - - metadata - title: _conversations_conversation_id_Request - _conversations_conversation_id_items_Request: - properties: - items: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - title: Items - type: object - required: - - items - title: _conversations_conversation_id_items_Request - _datasets_Request: - properties: - purpose: - title: Purpose - source: - title: Source - metadata: - title: Metadata - dataset_id: - title: Dataset Id - type: object - required: - - purpose - - source - title: _datasets_Request - _eval_benchmarks_benchmark_id_evaluations_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - benchmark_config: - $ref: '#/components/schemas/BenchmarkConfig' - type: object - required: - - input_rows - - scoring_functions - - benchmark_config - title: _eval_benchmarks_benchmark_id_evaluations_Request - _inference_rerank_Request: - properties: - model: - type: string - title: Model - query: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - items: - items: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - type: array - title: Items - max_num_results: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - model - - query - - items - title: _inference_rerank_Request - _models_Request: - properties: - model_id: - type: string - title: Model Id - provider_model_id: - anyOf: - - type: string - - type: 'null' - provider_id: - anyOf: - - type: string - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - model_type: - anyOf: - - $ref: '#/components/schemas/ModelType' - title: ModelType - - type: 'null' - title: ModelType - type: object - required: - - model_id - title: _models_Request - _moderations_Request: - properties: - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - model: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input - title: _moderations_Request - _post_training_preference_optimize_Request: - properties: - job_uuid: - type: string - title: Job Uuid - finetuned_model: - type: string - title: Finetuned Model - algorithm_config: - $ref: '#/components/schemas/DPOAlignmentConfig' - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - type: object - required: - - job_uuid - - finetuned_model - - algorithm_config - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_preference_optimize_Request - _post_training_supervised_fine_tune_Request: - properties: - job_uuid: - type: string - title: Job Uuid - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - model: - anyOf: - - type: string - - type: 'null' - description: Model descriptor for training if not in provider config` - checkpoint_dir: - anyOf: - - type: string - - type: 'null' - algorithm_config: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LoraFinetuningConfig' - title: LoraFinetuningConfig - - $ref: '#/components/schemas/QATFinetuningConfig' - title: QATFinetuningConfig - discriminator: - propertyName: type - mapping: - LoRA: '#/components/schemas/LoraFinetuningConfig' - QAT: '#/components/schemas/QATFinetuningConfig' - title: LoraFinetuningConfig | QATFinetuningConfig - - type: 'null' - title: Algorithm Config - type: object - required: - - job_uuid - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_supervised_fine_tune_Request - _prompts_Request: - properties: - prompt: - type: string - title: Prompt - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - required: - - prompt - title: _prompts_Request - _prompts_prompt_id_Request: - properties: - prompt: - type: string - title: Prompt - version: - type: integer - title: Version - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - set_as_default: - type: boolean - title: Set As Default - default: true - type: object - required: - - prompt - - version - title: _prompts_prompt_id_Request - _prompts_prompt_id_set_default_version_Request: - properties: - version: - type: integer - title: Version - type: object - required: - - version - title: _prompts_prompt_id_set_default_version_Request - _responses_Request: - properties: - input: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIResponseMessageInputUnion' - type: array - title: list[OpenAIResponseMessageInputUnion] - title: string | list[OpenAIResponseMessageInputUnion] - model: - type: string - title: Model - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - instructions: - anyOf: - - type: string - - type: 'null' - previous_response_id: - anyOf: - - type: string - - type: 'null' - conversation: - anyOf: - - type: string - - type: 'null' - store: - anyOf: - - type: boolean - - type: 'null' - default: true - stream: - anyOf: - - type: boolean - - type: 'null' - default: false - temperature: - anyOf: - - type: number - - type: 'null' - text: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseText' - title: OpenAIResponseText - - type: 'null' - title: OpenAIResponseText - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' - title: OpenAIResponseInputToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseInputToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - include: - anyOf: - - items: - type: string - type: array - - type: 'null' - max_infer_iters: - anyOf: - - type: integer - - type: 'null' - default: 10 - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - input - - model - title: _responses_Request - _scoring_score_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - type: object - required: - - input_rows - - scoring_functions - title: _scoring_score_Request - _scoring_score_batch_Request: - properties: - dataset_id: - type: string - title: Dataset Id - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - save_results_dataset: - type: boolean - title: Save Results Dataset - default: false - type: object - required: - - dataset_id - - scoring_functions - title: _scoring_score_batch_Request - _shields_Request: - properties: - shield_id: - type: string - title: Shield Id - provider_shield_id: - anyOf: - - type: string - - type: 'null' - provider_id: - anyOf: - - type: string - - type: 'null' - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - shield_id - title: _shields_Request - _tool_runtime_invoke_Request: - properties: - tool_name: - type: string - title: Tool Name - kwargs: - additionalProperties: true - type: object - title: Kwargs - type: object - required: - - tool_name - - kwargs - title: _tool_runtime_invoke_Request - _vector_io_query_Request: - properties: - vector_store_id: - type: string - title: Vector Store Id - query: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - vector_store_id - - query - title: _vector_io_query_Request - _vector_stores_vector_store_id_Request: - properties: - name: - anyOf: - - type: string - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: _vector_stores_vector_store_id_Request - _vector_stores_vector_store_id_files_Request: - properties: - file_id: - type: string - title: File Id - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - type: object - required: - - file_id - title: _vector_stores_vector_store_id_files_Request - _vector_stores_vector_store_id_files_file_id_Request: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - type: object - required: - - attributes - title: _vector_stores_vector_store_id_files_file_id_Request - _vector_stores_vector_store_id_search_Request: - properties: - query: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - rewrite_query: - anyOf: - - type: boolean - - type: 'null' - default: false - search_mode: - anyOf: - - type: string - - type: 'null' - default: vector - type: object - required: - - query - title: _vector_stores_vector_store_id_search_Request - Error: - description: Error response from the API. Roughly follows RFC 7807. - properties: - status: - title: Status - type: integer - title: - title: Title - type: string - detail: - title: Detail - type: string - instance: - anyOf: - - type: string - - type: 'null' - nullable: true - required: - - status - - title - - detail - title: Error - type: object ImageContentItem: description: A image content item properties: @@ -7167,6 +726,49 @@ components: - image title: ImageContentItem type: object + TextContentItem: + description: A text content item + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextContentItem + type: object + URL: + description: A URL reference to external content. + properties: + uri: + title: Uri + type: string + required: + - uri + title: URL + type: object + _URLOrData: + description: A URL or a base64 encoded string + properties: + url: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + data: + anyOf: + - type: string + - type: 'null' + contentEncoding: base64 + nullable: true + title: _URLOrData + type: object InterleavedContentItem: discriminator: mapping: @@ -7208,110 +810,54 @@ components: type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] - BuiltinTool: - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - title: BuiltinTool - type: string - ImageDelta: - description: An image content delta for streaming responses. + GreedySamplingStrategy: + description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: - const: image - default: image + const: greedy + default: greedy title: Type type: string - image: - format: binary - title: Image - type: string - required: - - image - title: ImageDelta + title: GreedySamplingStrategy type: object - TextDelta: - description: A text content delta for streaming responses. + TopKSamplingStrategy: + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: - const: text - default: text + const: top_k + default: top_k title: Type type: string - text: - title: Text - type: string + top_k: + minimum: 1 + title: Top K + type: integer required: - - text - title: TextDelta + - top_k + title: TopKSamplingStrategy type: object - ToolCall: + TopPSamplingStrategy: + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: - call_id: - title: Call Id + type: + const: top_p + default: top_p + title: Type type: string - tool_name: + temperature: anyOf: - - $ref: '#/components/schemas/BuiltinTool' - title: BuiltinTool - - type: string - title: BuiltinTool | string - arguments: - title: Arguments - type: string - required: - - call_id - - tool_name - - arguments - title: ToolCall - type: object - ToolCallDelta: - description: A tool call content delta for streaming responses. - properties: - type: - const: tool_call - default: tool_call - title: Type - type: string - tool_call: + - type: number + minimum: 0.0 + - type: 'null' + top_p: anyOf: - - type: string - - $ref: '#/components/schemas/ToolCall' - title: ToolCall - title: string | ToolCall - parse_status: - $ref: '#/components/schemas/ToolCallParseStatus' + - type: number + - type: 'null' + default: 0.95 required: - - tool_call - - parse_status - title: ToolCallDelta + - temperature + title: TopPSamplingStrategy type: object - ToolCallParseStatus: - description: Status of tool call parsing during streaming. - enum: - - started - - in_progress - - failed - - succeeded - title: ToolCallParseStatus - type: string - ContentDelta: - discriminator: - mapping: - image: '#/components/schemas/ImageDelta' - text: '#/components/schemas/TextDelta' - tool_call: '#/components/schemas/ToolCallDelta' - propertyName: type - oneOf: - - $ref: '#/components/schemas/TextDelta' - title: TextDelta - - $ref: '#/components/schemas/ImageDelta' - title: ImageDelta - - $ref: '#/components/schemas/ToolCallDelta' - title: ToolCallDelta - title: TextDelta | ImageDelta | ToolCallDelta SamplingStrategy: discriminator: mapping: @@ -7371,6 +917,82 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat + OpenAIChatCompletionContentPartImageParam: + description: Image content part for OpenAI-compatible chat completion messages. + properties: + type: + const: image_url + default: image_url + title: Type + type: string + image_url: + $ref: '#/components/schemas/OpenAIImageURL' + required: + - image_url + title: OpenAIChatCompletionContentPartImageParam + type: object + OpenAIChatCompletionContentPartTextParam: + description: Text content part for OpenAI-compatible chat completion messages. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: OpenAIChatCompletionContentPartTextParam + type: object + OpenAIFile: + properties: + type: + const: file + default: file + title: Type + type: string + file: + $ref: '#/components/schemas/OpenAIFileFile' + required: + - file + title: OpenAIFile + type: object + OpenAIFileFile: + properties: + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIFileFile + type: object + OpenAIImageURL: + description: Image URL specification for OpenAI-compatible chat completion messages. + properties: + url: + title: Url + type: string + detail: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - url + title: OpenAIImageURL + type: object OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -7418,6 +1040,122 @@ components: nullable: true title: OpenAIAssistantMessageParam type: object + OpenAIChatCompletionToolCall: + description: Tool call specification for OpenAI-compatible chat completion responses. + properties: + index: + anyOf: + - type: integer + - type: 'null' + nullable: true + id: + anyOf: + - type: string + - type: 'null' + nullable: true + type: + const: function + default: function + title: Type + type: string + function: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' + title: OpenAIChatCompletionToolCallFunction + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + title: OpenAIChatCompletionToolCall + type: object + OpenAIChatCompletionToolCallFunction: + description: Function call details for OpenAI-compatible tool calls. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + arguments: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + type: object + OpenAIDeveloperMessageParam: + description: A message from the developer in an OpenAI-compatible chat completion request. + properties: + role: + const: developer + default: developer + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAIDeveloperMessageParam + type: object + OpenAISystemMessageParam: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAISystemMessageParam + type: object + OpenAIToolMessageParam: + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. + properties: + role: + const: tool + default: tool + title: Role + type: string + tool_call_id: + title: Tool Call Id + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + required: + - tool_call_id + - content + title: OpenAIToolMessageParam + type: object OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -7477,6 +1215,61 @@ components: - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) + OpenAIJSONSchema: + description: JSON schema specification for OpenAI-compatible structured response format. + properties: + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + title: OpenAIJSONSchema + type: object + OpenAIResponseFormatJSONObject: + description: JSON object response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_object + default: json_object + title: Type + type: string + title: OpenAIResponseFormatJSONObject + type: object + OpenAIResponseFormatJSONSchema: + description: JSON schema response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_schema + default: json_schema + title: Type + type: string + json_schema: + $ref: '#/components/schemas/OpenAIJSONSchema' + required: + - json_schema + title: OpenAIResponseFormatJSONSchema + type: object + OpenAIResponseFormatText: + description: Text response format for OpenAI-compatible chat completion requests. + properties: + type: + const: text + default: text + title: Type + type: string + title: OpenAIResponseFormatText + type: object OpenAIResponseFormatParam: discriminator: mapping: @@ -7492,6 +1285,45 @@ components: - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + VectorStoreChunkingStrategyAuto: + description: Automatic chunking strategy for vector store files. + properties: + type: + const: auto + default: auto + title: Type + type: string + title: VectorStoreChunkingStrategyAuto + type: object + VectorStoreChunkingStrategyStatic: + description: Static chunking strategy with configurable parameters. + properties: + type: + const: static + default: static + title: Type + type: string + static: + $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + required: + - static + title: VectorStoreChunkingStrategyStatic + type: object + VectorStoreChunkingStrategyStaticConfig: + description: Configuration for static chunking strategy. + properties: + chunk_overlap_tokens: + default: 400 + title: Chunk Overlap Tokens + type: integer + max_chunk_size_tokens: + default: 800 + maximum: 4096 + minimum: 100 + title: Max Chunk Size Tokens + type: integer + title: VectorStoreChunkingStrategyStaticConfig + type: object VectorStoreChunkingStrategy: discriminator: mapping: @@ -7512,6 +1344,79 @@ components: - cancelled - failed default: completed + OpenAIResponseInputMessageContentFile: + description: File content for input messages in OpenAI response format. + properties: + type: + const: input_file + default: input_file + title: Type + type: string + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + file_url: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentFile + type: object + OpenAIResponseInputMessageContentImage: + description: Image content for input messages in OpenAI response format. + properties: + detail: + default: auto + title: Detail + type: string + enum: + - low + - high + - auto + type: + const: input_image + default: input_image + title: Type + type: string + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + image_url: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentImage + type: object + OpenAIResponseInputMessageContentText: + description: Text content for input messages in OpenAI response format. + properties: + text: + title: Text + type: string + type: + const: input_text + default: input_text + title: Type + type: string + required: + - text + title: OpenAIResponseInputMessageContentText + type: object OpenAIResponseInputMessageContent: discriminator: mapping: @@ -7527,6 +1432,104 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + OpenAIResponseAnnotationCitation: + description: URL citation annotation for referencing external web resources. + properties: + type: + const: url_citation + default: url_citation + title: Type + type: string + end_index: + title: End Index + type: integer + start_index: + title: Start Index + type: integer + title: + title: Title + type: string + url: + title: Url + type: string + required: + - end_index + - start_index + - title + - url + title: OpenAIResponseAnnotationCitation + type: object + OpenAIResponseAnnotationContainerFileCitation: + properties: + type: + const: container_file_citation + default: container_file_citation + title: Type + type: string + container_id: + title: Container Id + type: string + end_index: + title: End Index + type: integer + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + start_index: + title: Start Index + type: integer + required: + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation + type: object + OpenAIResponseAnnotationFileCitation: + description: File citation annotation for referencing specific files in response content. + properties: + type: + const: file_citation + default: file_citation + title: Type + type: string + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + index: + title: Index + type: integer + required: + - file_id + - filename + - index + title: OpenAIResponseAnnotationFileCitation + type: object + OpenAIResponseAnnotationFilePath: + properties: + type: + const: file_path + default: file_path + title: Type + type: string + file_id: + title: File Id + type: string + index: + title: Index + type: integer + required: + - file_id + - index + title: OpenAIResponseAnnotationFilePath + type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -7545,6 +1548,56 @@ components: - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + OpenAIResponseContentPartRefusal: + description: Refusal content within a streamed response part. + properties: + type: + const: refusal + default: refusal + title: Type + type: string + refusal: + title: Refusal + type: string + required: + - refusal + title: OpenAIResponseContentPartRefusal + type: object + OpenAIResponseOutputMessageContentOutputText: + properties: + text: + title: Text + type: string + type: + const: output_text + default: output_text + title: Type + type: string + annotations: + items: + discriminator: + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + title: OpenAIResponseAnnotationFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + title: OpenAIResponseAnnotationCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + title: OpenAIResponseAnnotationContainerFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + title: OpenAIResponseAnnotationFilePath + title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + title: Annotations + type: array + required: + - text + title: OpenAIResponseOutputMessageContentOutputText + type: object OpenAIResponseOutputMessageContent: discriminator: mapping: @@ -7557,6 +1610,53 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal + MCPListToolsTool: + description: Tool definition returned by MCP list tools operation. + properties: + input_schema: + additionalProperties: true + title: Input Schema + type: object + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - input_schema + - name + title: MCPListToolsTool + type: object + OpenAIResponseMCPApprovalRequest: + description: A request for human approval of a tool invocation. + properties: + arguments: + title: Arguments + type: string + id: + title: Id + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + type: + const: mcp_approval_request + default: mcp_approval_request + title: Type + type: string + required: + - arguments + - id + - name + - server_label + title: OpenAIResponseMCPApprovalRequest + type: object OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -7628,6 +1728,179 @@ components: - role title: OpenAIResponseMessage type: object + OpenAIResponseOutputMessageFileSearchToolCall: + description: File search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + queries: + items: + type: string + title: Queries + type: array + status: + title: Status + type: string + type: + const: file_search_call + default: file_search_call + title: Type + type: string + results: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' + type: array + - type: 'null' + nullable: true + required: + - id + - queries + - status + title: OpenAIResponseOutputMessageFileSearchToolCall + type: object + OpenAIResponseOutputMessageFileSearchToolCallResults: + description: Search results returned by the file search operation. + properties: + attributes: + additionalProperties: true + title: Attributes + type: object + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + score: + title: Score + type: number + text: + title: Text + type: string + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + type: object + OpenAIResponseOutputMessageFunctionToolCall: + description: Function tool call output message for OpenAI responses. + properties: + call_id: + title: Call Id + type: string + name: + title: Name + type: string + arguments: + title: Arguments + type: string + type: + const: function_call + default: function_call + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - name + - arguments + title: OpenAIResponseOutputMessageFunctionToolCall + type: object + OpenAIResponseOutputMessageMCPCall: + description: Model Context Protocol (MCP) call output message for OpenAI responses. + properties: + id: + title: Id + type: string + type: + const: mcp_call + default: mcp_call + title: Type + type: string + arguments: + title: Arguments + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + error: + anyOf: + - type: string + - type: 'null' + nullable: true + output: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + - arguments + - name + - server_label + title: OpenAIResponseOutputMessageMCPCall + type: object + OpenAIResponseOutputMessageMCPListTools: + description: MCP list tools output message containing available tools from an MCP server. + properties: + id: + title: Id + type: string + type: + const: mcp_list_tools + default: mcp_list_tools + title: Type + type: string + server_label: + title: Server Label + type: string + tools: + items: + $ref: '#/components/schemas/MCPListToolsTool' + title: Tools + type: array + required: + - id + - server_label + - tools + title: OpenAIResponseOutputMessageMCPListTools + type: object + OpenAIResponseOutputMessageWebSearchToolCall: + description: Web search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + status: + title: Status + type: string + type: + const: web_search_call + default: web_search_call + title: Type + type: string + required: + - id + - status + title: OpenAIResponseOutputMessageWebSearchToolCall + type: object OpenAIResponseOutput: discriminator: mapping: @@ -7655,6 +1928,186 @@ components: - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) + AllowedToolsFilter: + description: Filter configuration for restricting which MCP tools can be used. + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: AllowedToolsFilter + type: object + ApprovalFilter: + description: Filter configuration for MCP tool approval requirements. + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: ApprovalFilter + type: object + OpenAIResponseInputToolFileSearch: + description: File search tool configuration for OpenAI response inputs. + properties: + type: + const: file_search + default: file_search + title: Type + type: string + vector_store_ids: + items: + type: string + title: Vector Store Ids + type: array + filters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + max_num_results: + anyOf: + - maximum: 50 + minimum: 1 + type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + nullable: true + title: SearchRankingOptions + required: + - vector_store_ids + title: OpenAIResponseInputToolFileSearch + type: object + OpenAIResponseInputToolFunction: + description: Function tool configuration for OpenAI response inputs. + properties: + type: + const: function + default: function + title: Type + type: string + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + parameters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + nullable: true + required: + - name + - parameters + title: OpenAIResponseInputToolFunction + type: object + OpenAIResponseInputToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + server_url: + title: Server Url + type: string + headers: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + require_approval: + anyOf: + - const: always + type: string + - const: never + type: string + - $ref: '#/components/schemas/ApprovalFilter' + title: ApprovalFilter + default: never + title: string | ApprovalFilter + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + - server_url + title: OpenAIResponseInputToolMCP + type: object + OpenAIResponseInputToolWebSearch: + description: Web search tool configuration for OpenAI response inputs. + properties: + type: + default: web_search + title: Type + type: string + enum: + - web_search + - web_search_preview + - web_search_preview_2025_03_11 + - web_search_2025_08_26 + search_context_size: + anyOf: + - pattern: ^low|medium|high$ + type: string + - type: 'null' + default: medium + title: OpenAIResponseInputToolWebSearch + type: object + SearchRankingOptions: + description: Options for ranking and filtering search results. + properties: + ranker: + anyOf: + - type: string + - type: 'null' + nullable: true + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + title: SearchRankingOptions + type: object OpenAIResponseInputTool: discriminator: mapping: @@ -7676,6 +2129,32 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) + OpenAIResponseToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + title: OpenAIResponseToolMCP + type: object OpenAIResponseTool: discriminator: mapping: @@ -7786,6 +2265,164 @@ components: - text title: OpenAIResponseContentPartReasoningSummary type: object + OpenAIResponseError: + description: Error details for failed OpenAI response requests. + properties: + code: + title: Code + type: string + message: + title: Message + type: string + required: + - code + - message + title: OpenAIResponseError + type: object + OpenAIResponseObject: + description: Complete OpenAI response object containing generation results and metadata. + properties: + created_at: + title: Created At + type: integer + error: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseError' + title: OpenAIResponseError + - type: 'null' + nullable: true + title: OpenAIResponseError + id: + title: Id + type: string + model: + title: Model + type: string + object: + const: response + default: response + title: Object + type: string + output: + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + title: Output + type: array + parallel_tool_calls: + default: false + title: Parallel Tool Calls + type: boolean + previous_response_id: + anyOf: + - type: string + - type: 'null' + nullable: true + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + nullable: true + title: OpenAIResponsePrompt + status: + title: Status + type: string + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + text: + $ref: '#/components/schemas/OpenAIResponseText' + default: + format: + type: text + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + tools: + anyOf: + - items: + discriminator: + mapping: + file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' + function: '#/components/schemas/OpenAIResponseInputToolFunction' + mcp: '#/components/schemas/OpenAIResponseToolMCP' + web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + title: OpenAIResponseInputToolWebSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + title: OpenAIResponseInputToolFileSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + title: OpenAIResponseInputToolFunction + - $ref: '#/components/schemas/OpenAIResponseToolMCP' + title: OpenAIResponseToolMCP + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + nullable: true + truncation: + anyOf: + - type: string + - type: 'null' + nullable: true + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsage' + title: OpenAIResponseUsage + - type: 'null' + nullable: true + title: OpenAIResponseUsage + instructions: + anyOf: + - type: string + - type: 'null' + nullable: true + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + nullable: true + required: + - created_at + - id + - model + - output + - status + title: OpenAIResponseObject + type: object OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: @@ -8760,6 +3397,135 @@ components: - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object + OpenAIResponsePrompt: + description: OpenAI compatible Prompt object that is used in OpenAI responses. + properties: + id: + title: Id + type: string + variables: + anyOf: + - additionalProperties: + discriminator: + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: object + - type: 'null' + nullable: true + version: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + title: OpenAIResponsePrompt + type: object + OpenAIResponseText: + description: Text response configuration for OpenAI responses. + properties: + format: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseTextFormat' + title: OpenAIResponseTextFormat + - type: 'null' + nullable: true + title: OpenAIResponseTextFormat + title: OpenAIResponseText + type: object + OpenAIResponseTextFormat: + description: Configuration for Responses API text format. + properties: + type: + title: Type + type: string + enum: + - text + - json_schema + - json_object + default: text + name: + anyOf: + - type: string + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + title: OpenAIResponseTextFormat + type: object + OpenAIResponseUsage: + description: Usage information for OpenAI response. + properties: + input_tokens: + title: Input Tokens + type: integer + output_tokens: + title: Output Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + input_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' + title: OpenAIResponseUsageInputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + output_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' + title: OpenAIResponseUsageOutputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + required: + - input_tokens + - output_tokens + - total_tokens + title: OpenAIResponseUsage + type: object + OpenAIResponseUsageInputTokensDetails: + description: Token details for input tokens in OpenAI response usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + type: object + OpenAIResponseUsageOutputTokensDetails: + description: Token details for output tokens in OpenAI response usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + type: object OpenAIResponseObjectStream: discriminator: mapping: @@ -8874,6 +3640,64 @@ components: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) + OpenAIResponseInputFunctionToolCallOutput: + description: This represents the output of a function call that gets passed back to the model. + properties: + call_id: + title: Call Id + type: string + output: + title: Output + type: string + type: + const: function_call_output + default: function_call_output + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - output + title: OpenAIResponseInputFunctionToolCallOutput + type: object + OpenAIResponseMCPApprovalResponse: + description: A response to an MCP approval request. + properties: + approval_request_id: + title: Approval Request Id + type: string + approve: + title: Approve + type: boolean + type: + const: mcp_approval_response + default: mcp_approval_response + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + reason: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - approval_request_id + - approve + title: OpenAIResponseMCPApprovalResponse + type: object OpenAIResponseInput: anyOf: - discriminator: @@ -8909,51 +3733,96 @@ components: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage - ConversationItem: - discriminator: - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - propertyName: type - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - title: OpenAIResponseMessage - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - DataSource: - discriminator: - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - propertyName: type - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource + ArrayType: + description: Parameter type for array values. + properties: + type: + const: array + default: array + title: Type + type: string + title: ArrayType + type: object + BooleanType: + description: Parameter type for boolean values. + properties: + type: + const: boolean + default: boolean + title: Type + type: string + title: BooleanType + type: object + ChatCompletionInputType: + description: Parameter type for chat completion input. + properties: + type: + const: chat_completion_input + default: chat_completion_input + title: Type + type: string + title: ChatCompletionInputType + type: object + CompletionInputType: + description: Parameter type for completion input. + properties: + type: + const: completion_input + default: completion_input + title: Type + type: string + title: CompletionInputType + type: object + JsonType: + description: Parameter type for JSON values. + properties: + type: + const: json + default: json + title: Type + type: string + title: JsonType + type: object + NumberType: + description: Parameter type for numeric values. + properties: + type: + const: number + default: number + title: Type + type: string + title: NumberType + type: object + ObjectType: + description: Parameter type for object values. + properties: + type: + const: object + default: object + title: Type + type: string + title: ObjectType + type: object + StringType: + description: Parameter type for string values. + properties: + type: + const: string + default: string + title: Type + type: string + title: StringType + type: object + UnionType: + description: Parameter type for union values. + properties: + type: + const: union + default: union + title: Type + type: string + title: UnionType + type: object ParamType: discriminator: mapping: @@ -8987,6 +3856,164 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + ConversationItem: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + RowsDataSource: + description: A dataset stored in rows. + properties: + type: + const: rows + default: rows + title: Type + type: string + rows: + items: + additionalProperties: true + type: object + title: Rows + type: array + required: + - rows + title: RowsDataSource + type: object + URIDataSource: + description: A dataset that can be obtained from a URI. + properties: + type: + const: uri + default: uri + title: Type + type: string + uri: + title: Uri + type: string + required: + - uri + title: URIDataSource + type: object + DataSource: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + AggregationFunctionType: + description: Types of aggregation functions for scoring results. + enum: + - average + - weighted_average + - median + - categorical_count + - accuracy + title: AggregationFunctionType + type: string + BasicScoringFnParams: + description: Parameters for basic scoring function configuration. + properties: + type: + const: basic + default: basic + title: Type + type: string + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: BasicScoringFnParams + type: object + LLMAsJudgeScoringFnParams: + description: Parameters for LLM-as-judge scoring function configuration. + properties: + type: + const: llm_as_judge + default: llm_as_judge + title: Type + type: string + judge_model: + title: Judge Model + type: string + prompt_template: + anyOf: + - type: string + - type: 'null' + nullable: true + judge_score_regexes: + description: Regexes to extract the answer from generated response + items: + type: string + title: Judge Score Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + required: + - judge_model + title: LLMAsJudgeScoringFnParams + type: object + RegexParserScoringFnParams: + description: Parameters for regex parser scoring function configuration. + properties: + type: + const: regex_parser + default: regex_parser + title: Type + type: string + parsing_regexes: + description: Regex to extract the answer from generated response + items: + type: string + title: Parsing Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: RegexParserScoringFnParams + type: object ScoringFnParams: discriminator: mapping: @@ -9002,6 +4029,68 @@ components: - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + LoraFinetuningConfig: + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. + properties: + type: + const: LoRA + default: LoRA + title: Type + type: string + lora_attn_modules: + items: + type: string + title: Lora Attn Modules + type: array + apply_lora_to_mlp: + title: Apply Lora To Mlp + type: boolean + apply_lora_to_output: + title: Apply Lora To Output + type: boolean + rank: + title: Rank + type: integer + alpha: + title: Alpha + type: integer + use_dora: + anyOf: + - type: boolean + - type: 'null' + default: false + quantize_base: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + title: LoraFinetuningConfig + type: object + QATFinetuningConfig: + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. + properties: + type: + const: QAT + default: QAT + title: Type + type: string + quantizer_name: + title: Quantizer Name + type: string + group_size: + title: Group Size + type: integer + required: + - quantizer_name + - group_size + title: QATFinetuningConfig + type: object AlgorithmConfig: discriminator: mapping: @@ -9235,15 +4324,55 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - ResponseGuardrailSpec: - description: Specification for a guardrail to apply during response generation. + ListOpenAIResponseInputItem: + description: List container for OpenAI response input items. properties: - type: - title: Type + data: + items: + anyOf: + - discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage + title: Data + type: array + object: + const: list + default: list + title: Object type: string required: - - type - title: ResponseGuardrailSpec + - data + title: ListOpenAIResponseInputItem type: object OpenAIResponseObjectWithInput: description: OpenAI response object extended with input context information. @@ -9428,6 +4557,426 @@ components: - input title: OpenAIResponseObjectWithInput type: object + ListOpenAIResponseObject: + description: Paginated list of OpenAI response objects with navigation metadata. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIResponseObjectWithInput' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIResponseObject + type: object + OpenAIDeleteResponseObject: + description: Response object confirming deletion of an OpenAI response. + properties: + id: + title: Id + type: string + object: + const: response + default: response + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: OpenAIDeleteResponseObject + type: object + ResponseGuardrailSpec: + description: Specification for a guardrail to apply during response generation. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + Batch: + additionalProperties: true + properties: + id: + title: Id + type: string + completion_window: + title: Completion Window + type: string + created_at: + title: Created At + type: integer + endpoint: + title: Endpoint + type: string + input_file_id: + title: Input File Id + type: string + object: + const: batch + title: Object + type: string + status: + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + title: Status + type: string + cancelled_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + cancelling_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + completed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + error_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + errors: + anyOf: + - $ref: '#/components/schemas/Errors' + title: Errors + - type: 'null' + nullable: true + title: Errors + expired_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + failed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + finalizing_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + in_progress_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + nullable: true + model: + anyOf: + - type: string + - type: 'null' + nullable: true + output_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + request_counts: + anyOf: + - $ref: '#/components/schemas/BatchRequestCounts' + title: BatchRequestCounts + - type: 'null' + nullable: true + title: BatchRequestCounts + usage: + anyOf: + - $ref: '#/components/schemas/BatchUsage' + title: BatchUsage + - type: 'null' + nullable: true + title: BatchUsage + required: + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status + title: Batch + type: object + BatchError: + additionalProperties: true + properties: + code: + anyOf: + - type: string + - type: 'null' + nullable: true + line: + anyOf: + - type: integer + - type: 'null' + nullable: true + message: + anyOf: + - type: string + - type: 'null' + nullable: true + param: + anyOf: + - type: string + - type: 'null' + nullable: true + title: BatchError + type: object + BatchRequestCounts: + additionalProperties: true + properties: + completed: + title: Completed + type: integer + failed: + title: Failed + type: integer + total: + title: Total + type: integer + required: + - completed + - failed + - total + title: BatchRequestCounts + type: object + BatchUsage: + additionalProperties: true + properties: + input_tokens: + title: Input Tokens + type: integer + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + title: Output Tokens + type: integer + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + title: Total Tokens + type: integer + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + type: object + Errors: + additionalProperties: true + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + nullable: true + object: + anyOf: + - type: string + - type: 'null' + nullable: true + title: Errors + type: object + InputTokensDetails: + additionalProperties: true + properties: + cached_tokens: + title: Cached Tokens + type: integer + required: + - cached_tokens + title: InputTokensDetails + type: object + OutputTokensDetails: + additionalProperties: true + properties: + reasoning_tokens: + title: Reasoning Tokens + type: integer + required: + - reasoning_tokens + title: OutputTokensDetails + type: object + ListBatchesResponse: + description: Response containing a list of batch objects. + properties: + object: + const: list + default: list + title: Object + type: string + data: + description: List of batch objects + items: + $ref: '#/components/schemas/Batch' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: ID of the first batch in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: ID of the last batch in the list + nullable: true + has_more: + default: false + description: Whether there are more batches available + title: Has More + type: boolean + required: + - data + title: ListBatchesResponse + type: object + Benchmark: + description: A benchmark resource for evaluating model performance. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: benchmark + default: benchmark + title: Type + type: string + dataset_id: + title: Dataset Id + type: string + scoring_functions: + items: + type: string + title: Scoring Functions + type: array + metadata: + additionalProperties: true + description: Metadata for this evaluation task + title: Metadata + type: object + required: + - identifier + - provider_id + - dataset_id + - scoring_functions + title: Benchmark + type: object + ImageDelta: + description: An image content delta for streaming responses. + properties: + type: + const: image + default: image + title: Type + type: string + image: + format: binary + title: Image + type: string + required: + - image + title: ImageDelta + type: object + TextDelta: + description: A text content delta for streaming responses. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextDelta + type: object + JobStatus: + description: Status of a job execution. + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + type: string + Job: + description: A job execution instance with status tracking. + properties: + job_id: + title: Job Id + type: string + status: + $ref: '#/components/schemas/JobStatus' + required: + - job_id + - status + title: Job + type: object MetricInResponse: description: A metric value included in API responses. properties: @@ -9449,6 +4998,84 @@ components: - value title: MetricInResponse type: object + PaginatedResponse: + description: A generic paginated response that follows a simple format. + properties: + data: + items: + additionalProperties: true + type: object + title: Data + type: array + has_more: + title: Has More + type: boolean + url: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + - has_more + title: PaginatedResponse + type: object + PostTrainingMetric: + description: Training metrics captured during post-training jobs. + properties: + epoch: + title: Epoch + type: integer + train_loss: + title: Train Loss + type: number + validation_loss: + title: Validation Loss + type: number + perplexity: + title: Perplexity + type: number + required: + - epoch + - train_loss + - validation_loss + - perplexity + title: PostTrainingMetric + type: object + Checkpoint: + description: Checkpoint created during training runs. + properties: + identifier: + title: Identifier + type: string + created_at: + format: date-time + title: Created At + type: string + epoch: + title: Epoch + type: integer + post_training_job_id: + title: Post Training Job Id + type: string + path: + title: Path + type: string + training_metrics: + anyOf: + - $ref: '#/components/schemas/PostTrainingMetric' + title: PostTrainingMetric + - type: 'null' + nullable: true + title: PostTrainingMetric + required: + - identifier + - created_at + - epoch + - post_training_job_id + - path + title: Checkpoint + type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: @@ -9459,6 +5086,66 @@ components: type: string title: DialogType type: object + Conversation: + description: OpenAI-compatible conversation object. + properties: + id: + description: The unique ID of the conversation. + title: Id + type: string + object: + const: conversation + default: conversation + description: The object type, which is always conversation. + title: Object + type: string + created_at: + description: The time at which the conversation was created, measured in seconds since the Unix epoch. + title: Created At + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. + nullable: true + items: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + description: Initial items to include in the conversation context. You may add up to 20 items at a time. + nullable: true + required: + - id + - created_at + title: Conversation + type: object + ConversationDeletedResource: + description: Response for deleted conversation. + properties: + id: + description: The deleted conversation identifier + title: Id + type: string + object: + default: conversation.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationDeletedResource + type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: @@ -9504,6 +5191,93 @@ components: - items title: ConversationItemCreateRequest type: object + ConversationItemDeletedResource: + description: Response for deleted conversation item. + properties: + id: + description: The deleted item identifier + title: Id + type: string + object: + default: conversation.item.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationItemDeletedResource + type: object + ConversationItemList: + description: List of conversation items with pagination. + properties: + object: + default: list + description: Object type + title: Object + type: string + data: + description: List of conversation items + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the first item in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the last item in the list + nullable: true + has_more: + default: false + description: Whether there are more items available + title: Has More + type: boolean + required: + - data + title: ConversationItemList + type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: @@ -9543,6 +5317,857 @@ components: - status title: ConversationMessage type: object + DatasetPurpose: + description: Purpose of the dataset. Each purpose has a required input data schema. + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + type: string + Dataset: + description: Dataset resource for storing and accessing training or evaluation data. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: dataset + default: dataset + title: Type + type: string + purpose: + $ref: '#/components/schemas/DatasetPurpose' + source: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + metadata: + additionalProperties: true + description: Any additional metadata for this dataset + title: Metadata + type: object + required: + - identifier + - provider_id + - purpose + - source + title: Dataset + type: object + Error: + description: Error response from the API. Roughly follows RFC 7807. + properties: + status: + title: Status + type: integer + title: + title: Title + type: string + detail: + title: Detail + type: string + instance: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - status + - title + - detail + title: Error + type: object + Api: + description: Enumeration of all available APIs in the Llama Stack system. + enum: + - providers + - inference + - safety + - agents + - batches + - vector_io + - datasetio + - scoring + - eval + - post_training + - tool_runtime + - models + - shields + - vector_stores + - datasets + - scoring_functions + - benchmarks + - tool_groups + - files + - prompts + - conversations + - inspect + title: Api + type: string + InlineProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + container_image: + anyOf: + - type: string + - type: 'null' + description: |2 + + The container image to use for this implementation. If one is provided, pip_packages will be ignored. + If a provider depends on other providers, the dependencies MUST NOT specify a container image. + nullable: true + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + title: InlineProviderSpec + type: object + ModelType: + description: Enumeration of supported model types in Llama Stack. + enum: + - llm + - embedding + - rerank + title: ModelType + type: string + Model: + description: A model resource representing an AI model registered in Llama Stack. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: model + default: model + title: Type + type: string + metadata: + additionalProperties: true + description: Any additional metadata for this model + title: Metadata + type: object + model_type: + $ref: '#/components/schemas/ModelType' + default: llm + required: + - identifier + - provider_id + title: Model + type: object + ProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + required: + - api + - provider_type + - config_class + title: ProviderSpec + type: object + RemoteProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + adapter_type: + description: Unique identifier for this adapter + title: Adapter Type + type: string + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + - adapter_type + title: RemoteProviderSpec + type: object + ScoringFn: + description: A scoring function resource for evaluating model outputs. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: scoring_function + default: scoring_function + title: Type + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + description: Any additional metadata for this definition + title: Metadata + type: object + return_type: + description: The return type of the deterministic function + discriminator: + mapping: + array: '#/components/schemas/ArrayType' + boolean: '#/components/schemas/BooleanType' + chat_completion_input: '#/components/schemas/ChatCompletionInputType' + completion_input: '#/components/schemas/CompletionInputType' + json: '#/components/schemas/JsonType' + number: '#/components/schemas/NumberType' + object: '#/components/schemas/ObjectType' + string: '#/components/schemas/StringType' + union: '#/components/schemas/UnionType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/StringType' + title: StringType + - $ref: '#/components/schemas/NumberType' + title: NumberType + - $ref: '#/components/schemas/BooleanType' + title: BooleanType + - $ref: '#/components/schemas/ArrayType' + title: ArrayType + - $ref: '#/components/schemas/ObjectType' + title: ObjectType + - $ref: '#/components/schemas/JsonType' + title: JsonType + - $ref: '#/components/schemas/UnionType' + title: UnionType + - $ref: '#/components/schemas/ChatCompletionInputType' + title: ChatCompletionInputType + - $ref: '#/components/schemas/CompletionInputType' + title: CompletionInputType + title: StringType | ... (9 variants) + params: + anyOf: + - discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + title: Params + nullable: true + required: + - identifier + - provider_id + - return_type + title: ScoringFn + type: object + Shield: + description: A safety shield resource that can be used to check content. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: shield + default: shield + title: Type + type: string + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: Shield + type: object + ToolGroup: + description: A group of related tools managed together. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: tool_group + default: tool_group + title: Type + type: string + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: ToolGroup + type: object + ModelCandidate: + description: A model candidate for evaluation. + properties: + type: + const: model + default: model + title: Type + type: string + model: + title: Model + type: string + sampling_params: + $ref: '#/components/schemas/SamplingParams' + system_message: + anyOf: + - $ref: '#/components/schemas/SystemMessage' + title: SystemMessage + - type: 'null' + nullable: true + title: SystemMessage + required: + - model + - sampling_params + title: ModelCandidate + type: object + SamplingParams: + description: Sampling parameters. + properties: + strategy: + discriminator: + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreedySamplingStrategy' + title: GreedySamplingStrategy + - $ref: '#/components/schemas/TopPSamplingStrategy' + title: TopPSamplingStrategy + - $ref: '#/components/schemas/TopKSamplingStrategy' + title: TopKSamplingStrategy + title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + repetition_penalty: + anyOf: + - type: number + - type: 'null' + default: 1.0 + stop: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: SamplingParams + type: object + SystemMessage: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + title: string | list[ImageContentItem | TextContentItem] + required: + - content + title: SystemMessage + type: object + BenchmarkConfig: + description: A benchmark configuration for evaluation. + properties: + eval_candidate: + $ref: '#/components/schemas/ModelCandidate' + scoring_params: + additionalProperties: + discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + description: Map between scoring function id and parameters for each scoring function you want to run + title: Scoring Params + type: object + num_examples: + anyOf: + - type: integer + - type: 'null' + description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated + nullable: true + required: + - eval_candidate + title: BenchmarkConfig + type: object + ScoringResult: + description: A scoring result for a single row. + properties: + score_rows: + items: + additionalProperties: true + type: object + title: Score Rows + type: array + aggregated_results: + additionalProperties: true + title: Aggregated Results + type: object + required: + - score_rows + - aggregated_results + title: ScoringResult + type: object + EvaluateResponse: + description: The response from an evaluation. + properties: + generations: + items: + additionalProperties: true + type: object + title: Generations + type: array + scores: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Scores + type: object + required: + - generations + - scores + title: EvaluateResponse + type: object + ExpiresAfter: + description: |- + Control expiration of uploaded files. + + Params: + - anchor, must be "created_at" + - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) + properties: + anchor: + const: created_at + title: Anchor + type: string + seconds: + maximum: 2592000 + minimum: 3600 + title: Seconds + type: integer + required: + - anchor + - seconds + title: ExpiresAfter + type: object + OpenAIFileObject: + description: OpenAI File object as defined in the OpenAI Files API. + properties: + object: + const: file + default: file + title: Object + type: string + id: + title: Id + type: string + bytes: + title: Bytes + type: integer + created_at: + title: Created At + type: integer + expires_at: + title: Expires At + type: integer + filename: + title: Filename + type: string + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + required: + - id + - bytes + - created_at + - expires_at + - filename + - purpose + title: OpenAIFileObject + type: object + OpenAIFilePurpose: + description: Valid purpose values for OpenAI Files API. + enum: + - assistants + - batch + title: OpenAIFilePurpose + type: string + ListOpenAIFileResponse: + description: Response for listing files in OpenAI Files API. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIFileObject' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIFileResponse + type: object + OpenAIFileDeleteResponse: + description: Response for deleting a file in OpenAI Files API. + properties: + id: + title: Id + type: string + object: + const: file + default: file + title: Object + type: string + deleted: + title: Deleted + type: boolean + required: + - id + - deleted + title: OpenAIFileDeleteResponse + type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: @@ -9592,6 +6217,304 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig type: object + OpenAIChatCompletionUsage: + description: Usage information for OpenAI chat completion. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + completion_tokens: + title: Completion Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + prompt_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' + title: OpenAIChatCompletionUsagePromptTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + completion_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' + title: OpenAIChatCompletionUsageCompletionTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + required: + - prompt_tokens + - completion_tokens + - total_tokens + title: OpenAIChatCompletionUsage + type: object + OpenAIChatCompletionUsageCompletionTokensDetails: + description: Token details for output tokens in OpenAI chat completion usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + type: object + OpenAIChatCompletionUsagePromptTokensDetails: + description: Token details for prompt tokens in OpenAI chat completion usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + type: object + OpenAIChoice: + description: A choice from an OpenAI-compatible chat completion response. + properties: + message: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + finish_reason: + title: Finish Reason + type: string + index: + title: Index + type: integer + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + required: + - message + - finish_reason + - index + title: OpenAIChoice + type: object + OpenAIChoiceLogprobs: + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. + properties: + content: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + refusal: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + type: object + OpenAICompletionWithInputMessages: + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + input_messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + title: Input Messages + type: array + required: + - id + - choices + - created + - model + - input_messages + title: OpenAICompletionWithInputMessages + type: object + OpenAITokenLogProb: + description: |- + The log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + :top_logprobs: The top log probabilities for the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + title: Top Logprobs + type: array + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb + type: object + OpenAITopLogProb: + description: |- + The top log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + required: + - token + - logprob + title: OpenAITopLogProb + type: object + ListOpenAIChatCompletionResponse: + description: Response from listing OpenAI-compatible chat completions. + properties: + data: + items: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIChatCompletionResponse + type: object + OpenAIChatCompletion: + description: Response from an OpenAI-compatible chat completion request. + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + required: + - id + - choices + - created + - model + title: OpenAIChatCompletion + type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: @@ -9624,25 +6547,6 @@ components: nullable: true title: OpenAIChoiceDelta type: object - OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - title: OpenAIChoiceLogprobs - type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: @@ -9703,48 +6607,181 @@ components: - model title: OpenAIChatCompletionChunk type: object - OpenAIChoice: - description: A choice from an OpenAI-compatible chat completion response. + OpenAIChatCompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible chat completion endpoint. properties: - message: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - finish_reason: - title: Finish Reason + model: + title: Model type: string - index: - title: Index - type: integer - logprobs: + messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + minItems: 1 + title: Messages + type: array + frequency_penalty: anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs' - title: OpenAIChoiceLogprobs + - type: number + - type: 'null' + nullable: true + function_call: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + functions: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_completion_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + response_format: + anyOf: + - discriminator: + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseFormatText' + title: OpenAIResponseFormatText + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + title: OpenAIResponseFormatJSONSchema + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + title: OpenAIResponseFormatJSONObject + title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + - type: 'null' + title: Response Format + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + tool_choice: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + tools: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + top_logprobs: + anyOf: + - type: integer + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string - type: 'null' nullable: true - title: OpenAIChoiceLogprobs required: - - message - - finish_reason - - index - title: OpenAIChoice + - model + - messages + title: OpenAIChatCompletionRequestWithExtraBody type: object OpenAICompletionChoice: description: |- @@ -9777,6 +6814,42 @@ components: - index title: OpenAICompletionChoice type: object + OpenAICompletion: + description: |- + Response from an OpenAI-compatible completion request. + + :id: The ID of the completion + :choices: List of choices + :created: The Unix timestamp in seconds when the completion was created + :model: The model that was used to generate the completion + :object: The object type, which will be "text_completion" + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + title: Choices + type: array + created: + title: Created + type: integer + model: + title: Model + type: string + object: + const: text_completion + default: text_completion + title: Object + type: string + required: + - id + - choices + - created + - model + title: OpenAICompletion + type: object OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -9818,6 +6891,247 @@ components: nullable: true title: OpenAICompletionLogprobs type: object + OpenAICompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible completion endpoint. + properties: + model: + title: Model + type: string + prompt: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - items: + type: integer + type: array + title: list[integer] + - items: + items: + type: integer + type: array + type: array + title: list[array] + title: string | ... (4 variants) + best_of: + anyOf: + - type: integer + - type: 'null' + nullable: true + echo: + anyOf: + - type: boolean + - type: 'null' + nullable: true + frequency_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + suffix: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - prompt + title: OpenAICompletionRequestWithExtraBody + type: object + OpenAIEmbeddingData: + description: A single embedding data object from an OpenAI-compatible embeddings response. + properties: + object: + const: embedding + default: embedding + title: Object + type: string + embedding: + anyOf: + - items: + type: number + type: array + title: list[number] + - type: string + title: list[number] | string + index: + title: Index + type: integer + required: + - embedding + - index + title: OpenAIEmbeddingData + type: object + OpenAIEmbeddingUsage: + description: Usage information for an OpenAI-compatible embeddings response. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + required: + - prompt_tokens + - total_tokens + title: OpenAIEmbeddingUsage + type: object + OpenAIEmbeddingsRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible embeddings endpoint. + properties: + model: + title: Model + type: string + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + encoding_format: + anyOf: + - type: string + - type: 'null' + default: float + dimensions: + anyOf: + - type: integer + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - input + title: OpenAIEmbeddingsRequestWithExtraBody + type: object + OpenAIEmbeddingsResponse: + description: Response from an OpenAI-compatible embeddings request. + properties: + object: + const: list + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/OpenAIEmbeddingData' + title: Data + type: array + model: + title: Model + type: string + usage: + $ref: '#/components/schemas/OpenAIEmbeddingUsage' + required: + - data + - model + - usage + title: OpenAIEmbeddingsResponse + type: object + RerankData: + description: A single rerank result from a reranking response. + properties: + index: + title: Index + type: integer + relevance_score: + title: Relevance Score + type: number + required: + - index + - relevance_score + title: RerankData + type: object + RerankResponse: + description: Response from a reranking request. + properties: + data: + items: + $ref: '#/components/schemas/RerankData' + title: Data + type: array + required: + - data + title: RerankResponse + type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: @@ -9947,6 +7261,233 @@ components: - content title: UserMessage type: object + HealthStatus: + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + type: string + HealthInfo: + description: Health status information for the service. + properties: + status: + $ref: '#/components/schemas/HealthStatus' + required: + - status + title: HealthInfo + type: object + RouteInfo: + description: Information about an API route including its path, method, and implementing providers. + properties: + route: + title: Route + type: string + method: + title: Method + type: string + provider_types: + items: + type: string + title: Provider Types + type: array + required: + - route + - method + - provider_types + title: RouteInfo + type: object + ListRoutesResponse: + description: Response containing a list of all available API routes. + properties: + data: + items: + $ref: '#/components/schemas/RouteInfo' + title: Data + type: array + required: + - data + title: ListRoutesResponse + type: object + VersionInfo: + description: Version information for the service. + properties: + version: + title: Version + type: string + required: + - version + title: VersionInfo + type: object + OpenAIModel: + description: |- + A model from OpenAI. + + :id: The ID of the model + :object: The object type, which will be "model" + :created: The Unix timestamp in seconds when the model was created + :owned_by: The owner of the model + :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata + properties: + id: + title: Id + type: string + object: + const: model + default: model + title: Object + type: string + created: + title: Created + type: integer + owned_by: + title: Owned By + type: string + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - id + - created + - owned_by + title: OpenAIModel + type: object + DPOLossType: + enum: + - sigmoid + - hinge + - ipo + - kto_pair + title: DPOLossType + type: string + DPOAlignmentConfig: + description: Configuration for Direct Preference Optimization (DPO) alignment. + properties: + beta: + title: Beta + type: number + loss_type: + $ref: '#/components/schemas/DPOLossType' + default: sigmoid + required: + - beta + title: DPOAlignmentConfig + type: object + DatasetFormat: + description: Format of the training dataset. + enum: + - instruct + - dialog + title: DatasetFormat + type: string + DataConfig: + description: Configuration for training data and data loading. + properties: + dataset_id: + title: Dataset Id + type: string + batch_size: + title: Batch Size + type: integer + shuffle: + title: Shuffle + type: boolean + data_format: + $ref: '#/components/schemas/DatasetFormat' + validation_dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + packed: + anyOf: + - type: boolean + - type: 'null' + default: false + train_on_input: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - dataset_id + - batch_size + - shuffle + - data_format + title: DataConfig + type: object + EfficiencyConfig: + description: Configuration for memory and compute efficiency optimizations. + properties: + enable_activation_checkpointing: + anyOf: + - type: boolean + - type: 'null' + default: false + enable_activation_offloading: + anyOf: + - type: boolean + - type: 'null' + default: false + memory_efficient_fsdp_wrap: + anyOf: + - type: boolean + - type: 'null' + default: false + fsdp_cpu_offload: + anyOf: + - type: boolean + - type: 'null' + default: false + title: EfficiencyConfig + type: object + OptimizerType: + description: Available optimizer algorithms for training. + enum: + - adam + - adamw + - sgd + title: OptimizerType + type: string + OptimizerConfig: + description: Configuration parameters for the optimization algorithm. + properties: + optimizer_type: + $ref: '#/components/schemas/OptimizerType' + lr: + title: Lr + type: number + weight_decay: + title: Weight Decay + type: number + num_warmup_steps: + title: Num Warmup Steps + type: integer + required: + - optimizer_type + - lr + - weight_decay + - num_warmup_steps + title: OptimizerConfig + type: object + PostTrainingJobArtifactsResponse: + description: Artifacts of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + title: PostTrainingJobArtifactsResponse + type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -9963,12 +7504,103 @@ components: - log_lines title: PostTrainingJobLogStream type: object + PostTrainingJobStatusResponse: + description: Status of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + status: + $ref: '#/components/schemas/JobStatus' + scheduled_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + started_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + completed_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + resources_allocated: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + - status + title: PostTrainingJobStatusResponse + type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string + TrainingConfig: + description: Comprehensive configuration for the training process. + properties: + n_epochs: + title: N Epochs + type: integer + max_steps_per_epoch: + default: 1 + title: Max Steps Per Epoch + type: integer + gradient_accumulation_steps: + default: 1 + title: Gradient Accumulation Steps + type: integer + max_validation_steps: + anyOf: + - type: integer + - type: 'null' + default: 1 + data_config: + anyOf: + - $ref: '#/components/schemas/DataConfig' + title: DataConfig + - type: 'null' + nullable: true + title: DataConfig + optimizer_config: + anyOf: + - $ref: '#/components/schemas/OptimizerConfig' + title: OptimizerConfig + - type: 'null' + nullable: true + title: OptimizerConfig + efficiency_config: + anyOf: + - $ref: '#/components/schemas/EfficiencyConfig' + title: EfficiencyConfig + - type: 'null' + nullable: true + title: EfficiencyConfig + dtype: + anyOf: + - type: string + - type: 'null' + default: bf16 + required: + - n_epochs + title: TrainingConfig + type: object PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: @@ -10012,6 +7644,247 @@ components: - logger_config title: PostTrainingRLHFRequest type: object + Prompt: + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. + properties: + prompt: + anyOf: + - type: string + - type: 'null' + description: The system prompt with variable placeholders + nullable: true + version: + description: Version (integer starting at 1, incremented on save) + minimum: 1 + title: Version + type: integer + prompt_id: + description: Unique identifier in format 'pmpt_<48-digit-hash>' + title: Prompt Id + type: string + variables: + description: List of variable names that can be used in the prompt template + items: + type: string + title: Variables + type: array + is_default: + default: false + description: Boolean indicating whether this version is the default version + title: Is Default + type: boolean + required: + - version + - prompt_id + title: Prompt + type: object + ProviderInfo: + description: Information about a registered provider including its configuration and health status. + properties: + api: + title: Api + type: string + provider_id: + title: Provider Id + type: string + provider_type: + title: Provider Type + type: string + config: + additionalProperties: true + title: Config + type: object + health: + additionalProperties: true + title: Health + type: object + required: + - api + - provider_id + - provider_type + - config + - health + title: ProviderInfo + type: object + ModerationObjectResults: + description: A moderation object. + properties: + flagged: + title: Flagged + type: boolean + categories: + anyOf: + - additionalProperties: + type: boolean + type: object + - type: 'null' + nullable: true + category_applied_input_types: + anyOf: + - additionalProperties: + items: + type: string + type: array + type: object + - type: 'null' + nullable: true + category_scores: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - flagged + title: ModerationObjectResults + type: object + ModerationObject: + description: A moderation object. + properties: + id: + title: Id + type: string + model: + title: Model + type: string + results: + items: + $ref: '#/components/schemas/ModerationObjectResults' + title: Results + type: array + required: + - id + - model + - results + title: ModerationObject + type: object + SafetyViolation: + description: Details of a safety violation detected by content moderation. + properties: + violation_level: + $ref: '#/components/schemas/ViolationLevel' + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - violation_level + title: SafetyViolation + type: object + ViolationLevel: + description: Severity level of a safety violation. + enum: + - info + - warn + - error + title: ViolationLevel + type: string + RunShieldResponse: + description: Response from running a safety shield. + properties: + violation: + anyOf: + - $ref: '#/components/schemas/SafetyViolation' + title: SafetyViolation + - type: 'null' + nullable: true + title: SafetyViolation + title: RunShieldResponse + type: object + ScoreBatchResponse: + description: Response from batch scoring operations on datasets. + properties: + dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreBatchResponse + type: object + ScoreResponse: + description: The response from scoring. + properties: + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreResponse + type: object + ToolDef: + description: Tool definition used in runtime contexts. + properties: + toolgroup_id: + anyOf: + - type: string + - type: 'null' + nullable: true + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + input_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + output_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - name + title: ToolDef + type: object + ListToolDefsResponse: + description: Response containing a list of tool definitions. + properties: + data: + items: + $ref: '#/components/schemas/ToolDef' + title: Data + type: array + required: + - data + title: ListToolDefsResponse + type: object ToolGroupInput: description: Input data for registering a tool group. properties: @@ -10039,6 +7912,122 @@ components: - provider_id title: ToolGroupInput type: object + ToolInvocationResult: + description: Result of a tool invocation. + properties: + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + - type: 'null' + title: string | list[ImageContentItem | TextContentItem] + nullable: true + error_message: + anyOf: + - type: string + - type: 'null' + nullable: true + error_code: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: ToolInvocationResult + type: object + ChunkMetadata: + description: |- + `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that + will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` + is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. + Use `Chunk.metadata` for metadata that will be used in the context during inference. + properties: + chunk_id: + anyOf: + - type: string + - type: 'null' + nullable: true + document_id: + anyOf: + - type: string + - type: 'null' + nullable: true + source: + anyOf: + - type: string + - type: 'null' + nullable: true + created_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + updated_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + chunk_window: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_tokenizer: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_model: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_dimension: + anyOf: + - type: integer + - type: 'null' + nullable: true + content_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: ChunkMetadata + type: object Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -10097,6 +8086,140 @@ components: - chunk_id title: Chunk type: object + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store file batch with extra_body support. + properties: + file_ids: + items: + type: string + title: File Ids + type: array + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + required: + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + type: object + OpenAICreateVectorStoreRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store with extra_body support. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + file_ids: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: OpenAICreateVectorStoreRequestWithExtraBody + type: object + QueryChunksResponse: + description: Response from querying chunks in a vector database. + properties: + chunks: + items: + $ref: '#/components/schemas/Chunk' + title: Chunks + type: array + scores: + items: + type: number + title: Scores + type: array + required: + - chunks + - scores + title: QueryChunksResponse + type: object + VectorStoreContent: + description: Content item from a vector store file or search result. + properties: + type: + const: text + title: Type + type: string + text: + title: Text + type: string + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + nullable: true + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + nullable: true + title: ChunkMetadata + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - type + - text + title: VectorStoreContent + type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: @@ -10128,6 +8251,351 @@ components: type: object title: VectorStoreCreateRequest type: object + VectorStoreDeleteResponse: + description: Response from deleting a vector store. + properties: + id: + title: Id + type: string + object: + default: vector_store.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreDeleteResponse + type: object + VectorStoreFileCounts: + description: File processing status counts for a vector store. + properties: + completed: + title: Completed + type: integer + cancelled: + title: Cancelled + type: integer + failed: + title: Failed + type: integer + in_progress: + title: In Progress + type: integer + total: + title: Total + type: integer + required: + - completed + - cancelled + - failed + - in_progress + - total + title: VectorStoreFileCounts + type: object + VectorStoreFileBatchObject: + description: OpenAI Vector Store File Batch object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file_batch + title: Object + type: string + created_at: + title: Created At + type: integer + vector_store_id: + title: Vector Store Id + type: string + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + required: + - id + - created_at + - vector_store_id + - status + - file_counts + title: VectorStoreFileBatchObject + type: object + VectorStoreFileContentResponse: + description: Represents the parsed content of a vector store file. + properties: + object: + const: vector_store.file_content.page + default: vector_store.file_content.page + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreContent' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + title: VectorStoreFileContentResponse + type: object + VectorStoreFileDeleteResponse: + description: Response from deleting a vector store file. + properties: + id: + title: Id + type: string + object: + default: vector_store.file.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreFileDeleteResponse + type: object + VectorStoreFileLastError: + description: Error information for failed vector store file processing. + properties: + code: + title: Code + type: string + enum: + - server_error + - rate_limit_exceeded + default: server_error + message: + title: Message + type: string + required: + - code + - message + title: VectorStoreFileLastError + type: object + VectorStoreFileObject: + description: OpenAI Vector Store File object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file + title: Object + type: string + attributes: + additionalProperties: true + title: Attributes + type: object + chunking_strategy: + discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + created_at: + title: Created At + type: integer + last_error: + anyOf: + - $ref: '#/components/schemas/VectorStoreFileLastError' + title: VectorStoreFileLastError + - type: 'null' + nullable: true + title: VectorStoreFileLastError + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + vector_store_id: + title: Vector Store Id + type: string + required: + - id + - chunking_strategy + - created_at + - status + - vector_store_id + title: VectorStoreFileObject + type: object + VectorStoreFilesListInBatchResponse: + description: Response from listing files in a vector store file batch. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreFilesListInBatchResponse + type: object + VectorStoreListFilesResponse: + description: Response from listing files in a vector store. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListFilesResponse + type: object + VectorStoreObject: + description: OpenAI Vector Store object. + properties: + id: + title: Id + type: string + object: + default: vector_store + title: Object + type: string + created_at: + title: Created At + type: integer + name: + anyOf: + - type: string + - type: 'null' + nullable: true + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + status: + default: completed + title: Status + type: string + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + last_active_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - id + - created_at + - file_counts + title: VectorStoreObject + type: object + VectorStoreListResponse: + description: Response from listing vector stores. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListResponse + type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: @@ -10220,149 +8688,34 @@ components: - content title: VectorStoreSearchResponse type: object - _safety_run_shield_Request: + VectorStoreSearchResponsePage: + description: Paginated response from searching a vector store. properties: - shield_id: - title: Shield Id + object: + default: vector_store.search_results.page + title: Object type: string - messages: + search_query: items: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Messages + type: string + title: Search Query type: array - params: - additionalProperties: true - title: Params - type: object + data: + items: + $ref: '#/components/schemas/VectorStoreSearchResponse' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true required: - - shield_id - - messages - - params - title: _safety_run_shield_Request + - search_query + - data + title: VectorStoreSearchResponsePage type: object - OpenAIResponseMessageOutputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageOutputOneOf - title: OpenAIResponseMessage-Output | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageOutputUnion - OpenAIResponseMessageInputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageInputOneOf - title: OpenAIResponseMessage-Input | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageInputUnion - responses: - BadRequest400: - description: The request was invalid or malformed - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 400 - title: Bad Request - detail: The request was invalid or malformed - TooManyRequests429: - description: The client has sent too many requests in a given amount of time - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 429 - title: Too Many Requests - detail: You have exceeded the rate limit. Please try again later. - InternalServerError500: - description: The server encountered an unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 500 - title: Internal Server Error - detail: An unexpected error occurred - DefaultError: - description: An error occurred - content: - application/json: - schema: - $ref: '#/components/schemas/Error' diff --git a/docs/static/experimental-llama-stack-spec.yaml b/docs/static/experimental-llama-stack-spec.yaml index d0ed2b614..b5862cb52 100644 --- a/docs/static/experimental-llama-stack-spec.yaml +++ b/docs/static/experimental-llama-stack-spec.yaml @@ -18,21 +18,13 @@ paths: tags: - Inference summary: Rerank - description: Rerank a list of documents based on their relevance to a query. operationId: rerank_v1alpha_inference_rerank_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_inference_rerank_Request' - required: true responses: '200': - description: RerankResponse with indices sorted by relevance score (descending). + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/RerankResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -50,18 +42,7 @@ paths: tags: - Datasetio summary: Append Rows - description: Append rows to a dataset. operationId: append_rows_v1beta_datasetio_append_rows__dataset_id__post - requestBody: - content: - application/json: - schema: - items: - additionalProperties: true - type: object - type: array - title: Rows - required: true responses: '200': description: Successful Response @@ -92,73 +73,44 @@ paths: tags: - Datasetio summary: Iterrows - description: |- - Get a paginated list of rows from a dataset. - - Uses offset-based pagination where: - - start_index: The starting index (0-based). If None, starts from beginning. - - limit: Number of items to return. If None or -1, returns all items. - - The response includes: - - data: List of items for the current page. - - has_more: Whether there are more items available after this set. operationId: iterrows_v1beta_datasetio_iterrows__dataset_id__get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Limit - - name: start_index - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Start Index - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' - responses: - '200': - description: A PaginatedResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1beta/datasets/{dataset_id}: get: tags: - Datasets summary: Get Dataset - description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get responses: '200': - description: A Dataset. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Dataset' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -183,15 +135,13 @@ paths: tags: - Datasets summary: List Datasets - description: List all datasets. operationId: list_datasets_v1beta_datasets_get responses: '200': - description: A ListDatasetsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListDatasetsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -209,21 +159,13 @@ paths: tags: - Eval summary: Evaluate Rows - description: Evaluate a list of rows on a benchmark. operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_eval_benchmarks_benchmark_id_evaluations_Request' - required: true responses: '200': - description: EvaluateResponse object containing generations and scores. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/EvaluateResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -248,15 +190,13 @@ paths: tags: - Eval summary: Job Status - description: Get the status of a job. operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get responses: '200': - description: The status of the evaluation job. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Job' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -286,7 +226,6 @@ paths: tags: - Eval summary: Job Cancel - description: Cancel a job. operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete responses: '200': @@ -324,15 +263,13 @@ paths: tags: - Eval summary: Job Result - description: Get the result of a job. operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get responses: '200': - description: The result of the job. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/EvaluateResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -363,21 +300,13 @@ paths: tags: - Eval summary: Run Eval - description: Run an evaluation on a benchmark. operationId: run_eval_v1alpha_eval_benchmarks__benchmark_id__jobs_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BenchmarkConfig' - required: true responses: '200': - description: The job that was created to run the evaluation. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Job' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -402,15 +331,13 @@ paths: tags: - Benchmarks summary: Get Benchmark - description: Get a benchmark by its ID. operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get responses: '200': - description: A Benchmark. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Benchmark' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -435,41 +362,7 @@ paths: tags: - Benchmarks summary: List Benchmarks - description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get - responses: - '200': - description: A ListBenchmarksResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBenchmarksResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response - /v1alpha/post-training/job/cancel: - post: - tags: - - Post Training - summary: Cancel Training Job - description: Cancel a training job. - operationId: cancel_training_job_v1alpha_post_training_job_cancel_post - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': description: Successful Response @@ -477,97 +370,101 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' + /v1alpha/post-training/job/cancel: + post: + tags: + - Post Training + summary: Cancel Training Job + operationId: cancel_training_job_v1alpha_post_training_job_cancel_post + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/artifacts: get: tags: - Post Training summary: Get Training Job Artifacts - description: Get the artifacts of a training job. operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': - description: A PostTrainingJobArtifactsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/status: get: tags: - Post Training summary: Get Training Job Status - description: Get the status of a training job. operationId: get_training_job_status_v1alpha_post_training_job_status_get - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': - description: A PostTrainingJobStatusResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJobStatusResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/jobs: get: tags: - Post Training summary: Get Training Jobs - description: Get all training jobs. operationId: get_training_jobs_v1alpha_post_training_jobs_get responses: '200': - description: A ListPostTrainingJobsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPostTrainingJobsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -585,21 +482,13 @@ paths: tags: - Post Training summary: Preference Optimize - description: Run preference optimization of a model. operationId: preference_optimize_v1alpha_post_training_preference_optimize_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_post_training_preference_optimize_Request' - required: true responses: '200': - description: A PostTrainingJob. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJob' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -617,21 +506,13 @@ paths: tags: - Post Training summary: Supervised Fine Tune - description: Run supervised fine-tuning of a model. operationId: supervised_fine_tune_v1alpha_post_training_supervised_fine_tune_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_post_training_supervised_fine_tune_Request' - required: true responses: '200': - description: A PostTrainingJob. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJob' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -645,5220 +526,44 @@ paths: description: Default Response $ref: '#/components/responses/DefaultError' components: + responses: + BadRequest400: + description: The request was invalid or malformed + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 400 + title: Bad Request + detail: The request was invalid or malformed + TooManyRequests429: + description: The client has sent too many requests in a given amount of time + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 429 + title: Too Many Requests + detail: You have exceeded the rate limit. Please try again later. + InternalServerError500: + description: The server encountered an unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 500 + title: Internal Server Error + detail: An unexpected error occurred + DefaultError: + description: An error occurred + content: + application/json: + schema: + $ref: '#/components/schemas/Error' schemas: - AggregationFunctionType: - type: string - enum: - - average - - weighted_average - - median - - categorical_count - - accuracy - title: AggregationFunctionType - description: Types of aggregation functions for scoring results. - AllowedToolsFilter: - properties: - tool_names: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: AllowedToolsFilter - description: Filter configuration for restricting which MCP tools can be used. - ApprovalFilter: - properties: - always: - anyOf: - - items: - type: string - type: array - - type: 'null' - never: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: ApprovalFilter - description: Filter configuration for MCP tool approval requirements. - ArrayType: - properties: - type: - type: string - const: array - title: Type - default: array - type: object - title: ArrayType - description: Parameter type for array values. - BasicScoringFnParams: - properties: - type: - type: string - const: basic - title: Type - default: basic - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: BasicScoringFnParams - description: Parameters for basic scoring function configuration. - Batch: - properties: - id: - type: string - title: Id - completion_window: - type: string - title: Completion Window - created_at: - type: integer - title: Created At - endpoint: - type: string - title: Endpoint - input_file_id: - type: string - title: Input File Id - object: - type: string - const: batch - title: Object - status: - type: string - enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled - title: Status - cancelled_at: - anyOf: - - type: integer - - type: 'null' - cancelling_at: - anyOf: - - type: integer - - type: 'null' - completed_at: - anyOf: - - type: integer - - type: 'null' - error_file_id: - anyOf: - - type: string - - type: 'null' - errors: - anyOf: - - $ref: '#/components/schemas/Errors' - title: Errors - - type: 'null' - title: Errors - expired_at: - anyOf: - - type: integer - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - failed_at: - anyOf: - - type: integer - - type: 'null' - finalizing_at: - anyOf: - - type: integer - - type: 'null' - in_progress_at: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - model: - anyOf: - - type: string - - type: 'null' - output_file_id: - anyOf: - - type: string - - type: 'null' - request_counts: - anyOf: - - $ref: '#/components/schemas/BatchRequestCounts' - title: BatchRequestCounts - - type: 'null' - title: BatchRequestCounts - usage: - anyOf: - - $ref: '#/components/schemas/BatchUsage' - title: BatchUsage - - type: 'null' - title: BatchUsage - additionalProperties: true - type: object - required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status - title: Batch - BatchError: - properties: - code: - anyOf: - - type: string - - type: 'null' - line: - anyOf: - - type: integer - - type: 'null' - message: - anyOf: - - type: string - - type: 'null' - param: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: BatchError - BatchRequestCounts: - properties: - completed: - type: integer - title: Completed - failed: - type: integer - title: Failed - total: - type: integer - title: Total - additionalProperties: true - type: object - required: - - completed - - failed - - total - title: BatchRequestCounts - BatchUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - input_tokens_details: - $ref: '#/components/schemas/InputTokensDetails' - output_tokens: - type: integer - title: Output Tokens - output_tokens_details: - $ref: '#/components/schemas/OutputTokensDetails' - total_tokens: - type: integer - title: Total Tokens - additionalProperties: true - type: object - required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens - title: BatchUsage - Benchmark: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: benchmark - title: Type - default: benchmark - dataset_id: - type: string - title: Dataset Id - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - metadata: - additionalProperties: true - type: object - title: Metadata - description: Metadata for this evaluation task - type: object - required: - - identifier - - provider_id - - dataset_id - - scoring_functions - title: Benchmark - description: A benchmark resource for evaluating model performance. - BenchmarkConfig: - properties: - eval_candidate: - $ref: '#/components/schemas/ModelCandidate' - scoring_params: - additionalProperties: - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: object - title: Scoring Params - description: Map between scoring function id and parameters for each scoring function you want to run - num_examples: - anyOf: - - type: integer - - type: 'null' - description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated - type: object - required: - - eval_candidate - title: BenchmarkConfig - description: A benchmark configuration for evaluation. - BooleanType: - properties: - type: - type: string - const: boolean - title: Type - default: boolean - type: object - title: BooleanType - description: Parameter type for boolean values. - ChatCompletionInputType: - properties: - type: - type: string - const: chat_completion_input - title: Type - default: chat_completion_input - type: object - title: ChatCompletionInputType - description: Parameter type for chat completion input. - Checkpoint: - properties: - identifier: - type: string - title: Identifier - created_at: - type: string - format: date-time - title: Created At - epoch: - type: integer - title: Epoch - post_training_job_id: - type: string - title: Post Training Job Id - path: - type: string - title: Path - training_metrics: - anyOf: - - $ref: '#/components/schemas/PostTrainingMetric' - title: PostTrainingMetric - - type: 'null' - title: PostTrainingMetric - type: object - required: - - identifier - - created_at - - epoch - - post_training_job_id - - path - title: Checkpoint - description: Checkpoint created during training runs. - Chunk-Output: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - title: string | list[ImageContentItem-Output | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - ChunkMetadata: - properties: - chunk_id: - anyOf: - - type: string - - type: 'null' - document_id: - anyOf: - - type: string - - type: 'null' - source: - anyOf: - - type: string - - type: 'null' - created_timestamp: - anyOf: - - type: integer - - type: 'null' - updated_timestamp: - anyOf: - - type: integer - - type: 'null' - chunk_window: - anyOf: - - type: string - - type: 'null' - chunk_tokenizer: - anyOf: - - type: string - - type: 'null' - chunk_embedding_model: - anyOf: - - type: string - - type: 'null' - chunk_embedding_dimension: - anyOf: - - type: integer - - type: 'null' - content_token_count: - anyOf: - - type: integer - - type: 'null' - metadata_token_count: - anyOf: - - type: integer - - type: 'null' - type: object - title: ChunkMetadata - description: |- - `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that - will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` - is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. - Use `Chunk.metadata` for metadata that will be used in the context during inference. - CompletionInputType: - properties: - type: - type: string - const: completion_input - title: Type - default: completion_input - type: object - title: CompletionInputType - description: Parameter type for completion input. - Conversation: - properties: - id: - type: string - title: Id - description: The unique ID of the conversation. - object: - type: string - const: conversation - title: Object - description: The object type, which is always conversation. - default: conversation - created_at: - type: integer - title: Created At - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. - items: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - description: Initial items to include in the conversation context. You may add up to 20 items at a time. - type: object - required: - - id - - created_at - title: Conversation - description: OpenAI-compatible conversation object. - ConversationDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted conversation identifier - object: - type: string - title: Object - description: Object type - default: conversation.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationDeletedResource - description: Response for deleted conversation. - ConversationItemDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted item identifier - object: - type: string - title: Object - description: Object type - default: conversation.item.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationItemDeletedResource - description: Response for deleted conversation item. - ConversationItemList: - properties: - object: - type: string - title: Object - description: Object type - default: list - data: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (9 variants) - type: array - title: Data - description: List of conversation items - first_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the first item in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the last item in the list - has_more: - type: boolean - title: Has More - description: Whether there are more items available - default: false - type: object - required: - - data - title: ConversationItemList - description: List of conversation items with pagination. - DPOAlignmentConfig: - properties: - beta: - type: number - title: Beta - loss_type: - $ref: '#/components/schemas/DPOLossType' - default: sigmoid - type: object - required: - - beta - title: DPOAlignmentConfig - description: Configuration for Direct Preference Optimization (DPO) alignment. - DPOLossType: - type: string - enum: - - sigmoid - - hinge - - ipo - - kto_pair - title: DPOLossType - DataConfig: - properties: - dataset_id: - type: string - title: Dataset Id - batch_size: - type: integer - title: Batch Size - shuffle: - type: boolean - title: Shuffle - data_format: - $ref: '#/components/schemas/DatasetFormat' - validation_dataset_id: - anyOf: - - type: string - - type: 'null' - packed: - anyOf: - - type: boolean - - type: 'null' - default: false - train_on_input: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - dataset_id - - batch_size - - shuffle - - data_format - title: DataConfig - description: Configuration for training data and data loading. - Dataset: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: dataset - title: Type - default: dataset - purpose: - $ref: '#/components/schemas/DatasetPurpose' - source: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource - discriminator: - propertyName: type - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this dataset - type: object - required: - - identifier - - provider_id - - purpose - - source - title: Dataset - description: Dataset resource for storing and accessing training or evaluation data. - DatasetFormat: - type: string - enum: - - instruct - - dialog - title: DatasetFormat - description: Format of the training dataset. - DatasetPurpose: - type: string - enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - title: DatasetPurpose - description: Purpose of the dataset. Each purpose has a required input data schema. - EfficiencyConfig: - properties: - enable_activation_checkpointing: - anyOf: - - type: boolean - - type: 'null' - default: false - enable_activation_offloading: - anyOf: - - type: boolean - - type: 'null' - default: false - memory_efficient_fsdp_wrap: - anyOf: - - type: boolean - - type: 'null' - default: false - fsdp_cpu_offload: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - title: EfficiencyConfig - description: Configuration for memory and compute efficiency optimizations. - Errors: - properties: - data: - anyOf: - - items: - $ref: '#/components/schemas/BatchError' - type: array - - type: 'null' - object: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: Errors - EvaluateResponse: - properties: - generations: - items: - additionalProperties: true - type: object - type: array - title: Generations - scores: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Scores - type: object - required: - - generations - - scores - title: EvaluateResponse - description: The response from an evaluation. - ExpiresAfter: - properties: - anchor: - type: string - const: created_at - title: Anchor - seconds: - type: integer - maximum: 2592000.0 - minimum: 3600.0 - title: Seconds - type: object - required: - - anchor - - seconds - title: ExpiresAfter - description: |- - Control expiration of uploaded files. - - Params: - - anchor, must be "created_at" - - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) - GreedySamplingStrategy: - properties: - type: - type: string - const: greedy - title: Type - default: greedy - type: object - title: GreedySamplingStrategy - description: Greedy sampling strategy that selects the highest probability token at each step. - HealthInfo: - properties: - status: - $ref: '#/components/schemas/HealthStatus' - type: object - required: - - status - title: HealthInfo - description: Health status information for the service. - HealthStatus: - type: string - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - ImageContentItem-Input: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - ImageContentItem-Output: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - InputTokensDetails: - properties: - cached_tokens: - type: integer - title: Cached Tokens - additionalProperties: true - type: object - required: - - cached_tokens - title: InputTokensDetails - Job: - properties: - job_id: - type: string - title: Job Id - status: - $ref: '#/components/schemas/JobStatus' - type: object - required: - - job_id - - status - title: Job - description: A job execution instance with status tracking. - JobStatus: - type: string - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - description: Status of a job execution. - JsonType: - properties: - type: - type: string - const: json - title: Type - default: json - type: object - title: JsonType - description: Parameter type for JSON values. - LLMAsJudgeScoringFnParams: - properties: - type: - type: string - const: llm_as_judge - title: Type - default: llm_as_judge - judge_model: - type: string - title: Judge Model - prompt_template: - anyOf: - - type: string - - type: 'null' - judge_score_regexes: - items: - type: string - type: array - title: Judge Score Regexes - description: Regexes to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - required: - - judge_model - title: LLMAsJudgeScoringFnParams - description: Parameters for LLM-as-judge scoring function configuration. - ListBatchesResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/Batch' - type: array - title: Data - description: List of batch objects - first_id: - anyOf: - - type: string - - type: 'null' - description: ID of the first batch in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: ID of the last batch in the list - has_more: - type: boolean - title: Has More - description: Whether there are more batches available - default: false - type: object - required: - - data - title: ListBatchesResponse - description: Response containing a list of batch objects. - ListBenchmarksResponse: - properties: - data: - items: - $ref: '#/components/schemas/Benchmark' - type: array - title: Data - type: object - required: - - data - title: ListBenchmarksResponse - ListDatasetsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Dataset' - type: array - title: Data - type: object - required: - - data - title: ListDatasetsResponse - description: Response from listing datasets. - ListOpenAIChatCompletionResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIChatCompletionResponse - description: Response from listing OpenAI-compatible chat completions. - ListOpenAIFileResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIFileObject' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIFileResponse - description: Response for listing files in OpenAI Files API. - ListOpenAIResponseInputItem: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Data - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - title: ListOpenAIResponseInputItem - description: List container for OpenAI response input items. - ListOpenAIResponseObject: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseObjectWithInput-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIResponseObject - description: Paginated list of OpenAI response objects with navigation metadata. - ListPostTrainingJobsResponse: - properties: - data: - items: - $ref: '#/components/schemas/PostTrainingJob' - type: array - title: Data - type: object - required: - - data - title: ListPostTrainingJobsResponse - ListRoutesResponse: - properties: - data: - items: - $ref: '#/components/schemas/RouteInfo' - type: array - title: Data - type: object - required: - - data - title: ListRoutesResponse - description: Response containing a list of all available API routes. - ListToolDefsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolDef' - type: array - title: Data - type: object - required: - - data - title: ListToolDefsResponse - description: Response containing a list of tool definitions. - LoraFinetuningConfig: - properties: - type: - type: string - const: LoRA - title: Type - default: LoRA - lora_attn_modules: - items: - type: string - type: array - title: Lora Attn Modules - apply_lora_to_mlp: - type: boolean - title: Apply Lora To Mlp - apply_lora_to_output: - type: boolean - title: Apply Lora To Output - rank: - type: integer - title: Rank - alpha: - type: integer - title: Alpha - use_dora: - anyOf: - - type: boolean - - type: 'null' - default: false - quantize_base: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - title: LoraFinetuningConfig - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. - MCPListToolsTool: - properties: - input_schema: - additionalProperties: true - type: object - title: Input Schema - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_schema - - name - title: MCPListToolsTool - description: Tool definition returned by MCP list tools operation. - Model: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: model - title: Type - default: model - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this model - model_type: - $ref: '#/components/schemas/ModelType' - default: llm - type: object - required: - - identifier - - provider_id - title: Model - description: A model resource representing an AI model registered in Llama Stack. - ModelCandidate: - properties: - type: - type: string - const: model - title: Type - default: model - model: - type: string - title: Model - sampling_params: - $ref: '#/components/schemas/SamplingParams' - system_message: - anyOf: - - $ref: '#/components/schemas/SystemMessage' - title: SystemMessage - - type: 'null' - title: SystemMessage - type: object - required: - - model - - sampling_params - title: ModelCandidate - description: A model candidate for evaluation. - ModelType: - type: string - enum: - - llm - - embedding - - rerank - title: ModelType - description: Enumeration of supported model types in Llama Stack. - ModerationObject: - properties: - id: - type: string - title: Id - model: - type: string - title: Model - results: - items: - $ref: '#/components/schemas/ModerationObjectResults' - type: array - title: Results - type: object - required: - - id - - model - - results - title: ModerationObject - description: A moderation object. - ModerationObjectResults: - properties: - flagged: - type: boolean - title: Flagged - categories: - anyOf: - - additionalProperties: - type: boolean - type: object - - type: 'null' - category_applied_input_types: - anyOf: - - additionalProperties: - items: - type: string - type: array - type: object - - type: 'null' - category_scores: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - flagged - title: ModerationObjectResults - description: A moderation object. - NumberType: - properties: - type: - type: string - const: number - title: Type - default: number - type: object - title: NumberType - description: Parameter type for numeric values. - ObjectType: - properties: - type: - type: string - const: object - title: Type - default: object - type: object - title: ObjectType - description: Parameter type for object values. - OpenAIAssistantMessageParam-Input: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIAssistantMessageParam-Output: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIChatCompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - type: object - required: - - id - - choices - - created - - model - title: OpenAIChatCompletion - description: Response from an OpenAI-compatible chat completion request. - OpenAIChatCompletionContentPartImageParam: - properties: - type: - type: string - const: image_url - title: Type - default: image_url - image_url: - $ref: '#/components/schemas/OpenAIImageURL' - type: object - required: - - image_url - title: OpenAIChatCompletionContentPartImageParam - description: Image content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionContentPartTextParam: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: OpenAIChatCompletionContentPartTextParam - description: Text content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' - title: OpenAIAssistantMessageParam-Input - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input | ... (5 variants) - type: array - minItems: 1 - title: Messages - frequency_penalty: - anyOf: - - type: number - - type: 'null' - function_call: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - functions: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_completion_tokens: - anyOf: - - type: integer - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - response_format: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - title: OpenAIResponseFormatJSONSchema - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' - title: OpenAIResponseFormatJSONObject - discriminator: - propertyName: type - mapping: - json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' - json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' - text: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - - type: 'null' - title: Response Format - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - tool_choice: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - tools: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - top_logprobs: - anyOf: - - type: integer - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - messages - title: OpenAIChatCompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible chat completion endpoint. - OpenAIChatCompletionToolCall: - properties: - index: - anyOf: - - type: integer - - type: 'null' - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - const: function - title: Type - default: function - function: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' - title: OpenAIChatCompletionToolCallFunction - - type: 'null' - title: OpenAIChatCompletionToolCallFunction - type: object - title: OpenAIChatCompletionToolCall - description: Tool call specification for OpenAI-compatible chat completion responses. - OpenAIChatCompletionToolCallFunction: - properties: - name: - anyOf: - - type: string - - type: 'null' - arguments: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIChatCompletionToolCallFunction - description: Function call details for OpenAI-compatible tool calls. - OpenAIChatCompletionUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - completion_tokens: - type: integer - title: Completion Tokens - total_tokens: - type: integer - title: Total Tokens - prompt_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' - title: OpenAIChatCompletionUsagePromptTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsagePromptTokensDetails - completion_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' - title: OpenAIChatCompletionUsageCompletionTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsageCompletionTokensDetails - type: object - required: - - prompt_tokens - - completion_tokens - - total_tokens - title: OpenAIChatCompletionUsage - description: Usage information for OpenAI chat completion. - OpenAIChatCompletionUsageCompletionTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsageCompletionTokensDetails - description: Token details for output tokens in OpenAI chat completion usage. - OpenAIChatCompletionUsagePromptTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsagePromptTokensDetails - description: Token details for prompt tokens in OpenAI chat completion usage. - OpenAIChoice-Output: - properties: - message: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam-Output | ... (5 variants) - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - finish_reason: - type: string - title: Finish Reason - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - message - - finish_reason - - index - title: OpenAIChoice - description: A choice from an OpenAI-compatible chat completion response. - OpenAIChoiceLogprobs-Output: - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - type: object - title: OpenAIChoiceLogprobs - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - OpenAICompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAICompletionChoice-Output' - type: array - title: Choices - created: - type: integer - title: Created - model: - type: string - title: Model - object: - type: string - const: text_completion - title: Object - default: text_completion - type: object - required: - - id - - choices - - created - - model - title: OpenAICompletion - description: |- - Response from an OpenAI-compatible completion request. - - :id: The ID of the completion - :choices: List of choices - :created: The Unix timestamp in seconds when the completion was created - :model: The model that was used to generate the completion - :object: The object type, which will be "text_completion" - OpenAICompletionChoice-Output: - properties: - finish_reason: - type: string - title: Finish Reason - text: - type: string - title: Text - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - finish_reason - - text - - index - title: OpenAICompletionChoice - description: |- - A choice from an OpenAI-compatible completion response. - - :finish_reason: The reason the model stopped generating - :text: The text of the choice - :index: The index of the choice - :logprobs: (Optional) The log probabilities for the tokens in the choice - OpenAICompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - prompt: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - items: - type: integer - type: array - title: list[integer] - - items: - items: - type: integer - type: array - type: array - title: list[array] - title: string | ... (4 variants) - best_of: - anyOf: - - type: integer - - type: 'null' - echo: - anyOf: - - type: boolean - - type: 'null' - frequency_penalty: - anyOf: - - type: number - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - suffix: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - prompt - title: OpenAICompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible completion endpoint. - OpenAICompletionWithInputMessages: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - input_messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output | ... (5 variants) - type: array - title: Input Messages - type: object - required: - - id - - choices - - created - - model - - input_messages - title: OpenAICompletionWithInputMessages - OpenAICreateVectorStoreFileBatchRequestWithExtraBody: - properties: - file_ids: - items: - type: string - type: array - title: File Ids - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - additionalProperties: true - type: object - required: - - file_ids - title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: Request to create a vector store file batch with extra_body support. - OpenAICreateVectorStoreRequestWithExtraBody: - properties: - name: - anyOf: - - type: string - - type: 'null' - file_ids: - anyOf: - - items: - type: string - type: array - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - additionalProperties: true - type: object - title: OpenAICreateVectorStoreRequestWithExtraBody - description: Request to create a vector store with extra_body support. - OpenAIDeleteResponseObject: - properties: - id: - type: string - title: Id - object: - type: string - const: response - title: Object - default: response - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: OpenAIDeleteResponseObject - description: Response object confirming deletion of an OpenAI response. - OpenAIDeveloperMessageParam: - properties: - role: - type: string - const: developer - title: Role - default: developer - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIDeveloperMessageParam - description: A message from the developer in an OpenAI-compatible chat completion request. - OpenAIEmbeddingData: - properties: - object: - type: string - const: embedding - title: Object - default: embedding - embedding: - anyOf: - - items: - type: number - type: array - title: list[number] - - type: string - title: list[number] | string - index: - type: integer - title: Index - type: object - required: - - embedding - - index - title: OpenAIEmbeddingData - description: A single embedding data object from an OpenAI-compatible embeddings response. - OpenAIEmbeddingUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - total_tokens: - type: integer - title: Total Tokens - type: object - required: - - prompt_tokens - - total_tokens - title: OpenAIEmbeddingUsage - description: Usage information for an OpenAI-compatible embeddings response. - OpenAIEmbeddingsRequestWithExtraBody: - properties: - model: - type: string - title: Model - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - encoding_format: - anyOf: - - type: string - - type: 'null' - default: float - dimensions: - anyOf: - - type: integer - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - input - title: OpenAIEmbeddingsRequestWithExtraBody - description: Request parameters for OpenAI-compatible embeddings endpoint. - OpenAIEmbeddingsResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/OpenAIEmbeddingData' - type: array - title: Data - model: - type: string - title: Model - usage: - $ref: '#/components/schemas/OpenAIEmbeddingUsage' - type: object - required: - - data - - model - - usage - title: OpenAIEmbeddingsResponse - description: Response from an OpenAI-compatible embeddings request. - OpenAIFile: - properties: - type: - type: string - const: file - title: Type - default: file - file: - $ref: '#/components/schemas/OpenAIFileFile' - type: object - required: - - file - title: OpenAIFile - OpenAIFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - const: file - title: Object - default: file - deleted: - type: boolean - title: Deleted - type: object - required: - - id - - deleted - title: OpenAIFileDeleteResponse - description: Response for deleting a file in OpenAI Files API. - OpenAIFileFile: - properties: - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIFileFile - OpenAIFileObject: - properties: - object: - type: string - const: file - title: Object - default: file - id: - type: string - title: Id - bytes: - type: integer - title: Bytes - created_at: - type: integer - title: Created At - expires_at: - type: integer - title: Expires At - filename: - type: string - title: Filename - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - type: object - required: - - id - - bytes - - created_at - - expires_at - - filename - - purpose - title: OpenAIFileObject - description: OpenAI File object as defined in the OpenAI Files API. - OpenAIFilePurpose: - type: string - enum: - - assistants - - batch - title: OpenAIFilePurpose - description: Valid purpose values for OpenAI Files API. - OpenAIImageURL: - properties: - url: - type: string - title: Url - detail: - anyOf: - - type: string - - type: 'null' - type: object - required: - - url - title: OpenAIImageURL - description: Image URL specification for OpenAI-compatible chat completion messages. - OpenAIJSONSchema: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: OpenAIJSONSchema - description: JSON schema specification for OpenAI-compatible structured response format. - OpenAIModel: - properties: - id: - type: string - title: Id - object: - type: string - const: model - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - custom_metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - id - - created - - owned_by - title: OpenAIModel - description: |- - A model from OpenAI. - - :id: The ID of the model - :object: The object type, which will be "model" - :created: The Unix timestamp in seconds when the model was created - :owned_by: The owner of the model - :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata - OpenAIResponseAnnotationCitation: - properties: - type: - type: string - const: url_citation - title: Type - default: url_citation - end_index: - type: integer - title: End Index - start_index: - type: integer - title: Start Index - title: - type: string - title: Title - url: - type: string - title: Url - type: object - required: - - end_index - - start_index - - title - - url - title: OpenAIResponseAnnotationCitation - description: URL citation annotation for referencing external web resources. - OpenAIResponseAnnotationContainerFileCitation: - properties: - type: - type: string - const: container_file_citation - title: Type - default: container_file_citation - container_id: - type: string - title: Container Id - end_index: - type: integer - title: End Index - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - start_index: - type: integer - title: Start Index - type: object - required: - - container_id - - end_index - - file_id - - filename - - start_index - title: OpenAIResponseAnnotationContainerFileCitation - OpenAIResponseAnnotationFileCitation: - properties: - type: - type: string - const: file_citation - title: Type - default: file_citation - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - index: - type: integer - title: Index - type: object - required: - - file_id - - filename - - index - title: OpenAIResponseAnnotationFileCitation - description: File citation annotation for referencing specific files in response content. - OpenAIResponseAnnotationFilePath: - properties: - type: - type: string - const: file_path - title: Type - default: file_path - file_id: - type: string - title: File Id - index: - type: integer - title: Index - type: object - required: - - file_id - - index - title: OpenAIResponseAnnotationFilePath - OpenAIResponseContentPartRefusal: - properties: - type: - type: string - const: refusal - title: Type - default: refusal - refusal: - type: string - title: Refusal - type: object - required: - - refusal - title: OpenAIResponseContentPartRefusal - description: Refusal content within a streamed response part. - OpenAIResponseError: - properties: - code: - type: string - title: Code - message: - type: string - title: Message - type: object - required: - - code - - message - title: OpenAIResponseError - description: Error details for failed OpenAI response requests. - OpenAIResponseFormatJSONObject: - properties: - type: - type: string - const: json_object - title: Type - default: json_object - type: object - title: OpenAIResponseFormatJSONObject - description: JSON object response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatJSONSchema: - properties: - type: - type: string - const: json_schema - title: Type - default: json_schema - json_schema: - $ref: '#/components/schemas/OpenAIJSONSchema' - type: object - required: - - json_schema - title: OpenAIResponseFormatJSONSchema - description: JSON schema response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatText: - properties: - type: - type: string - const: text - title: Type - default: text - type: object - title: OpenAIResponseFormatText - description: Text response format for OpenAI-compatible chat completion requests. - OpenAIResponseInputFunctionToolCallOutput: - properties: - call_id: - type: string - title: Call Id - output: - type: string - title: Output - type: - type: string - const: function_call_output - title: Type - default: function_call_output - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - output - title: OpenAIResponseInputFunctionToolCallOutput - description: This represents the output of a function call that gets passed back to the model. - OpenAIResponseInputMessageContentFile: - properties: - type: - type: string - const: input_file - title: Type - default: input_file - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - file_url: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentFile - description: File content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentImage: - properties: - detail: - title: Detail - default: auto - type: string - enum: - - low - - high - - auto - type: - type: string - const: input_image - title: Type - default: input_image - file_id: - anyOf: - - type: string - - type: 'null' - image_url: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentImage - description: Image content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentText: - properties: - text: - type: string - title: Text - type: - type: string - const: input_text - title: Type - default: input_text - type: object - required: - - text - title: OpenAIResponseInputMessageContentText - description: Text content for input messages in OpenAI response format. - OpenAIResponseInputToolFileSearch: - properties: - type: - type: string - const: file_search - title: Type - default: file_search - vector_store_ids: - items: - type: string - type: array - title: Vector Store Ids - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - maximum: 50.0 - minimum: 1.0 - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - type: object - required: - - vector_store_ids - title: OpenAIResponseInputToolFileSearch - description: File search tool configuration for OpenAI response inputs. - OpenAIResponseInputToolFunction: - properties: - type: - type: string - const: function - title: Type - default: function - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - required: - - name - - parameters - title: OpenAIResponseInputToolFunction - description: Function tool configuration for OpenAI response inputs. - OpenAIResponseInputToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - server_url: - type: string - title: Server Url - headers: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - require_approval: - anyOf: - - type: string - const: always - - type: string - const: never - - $ref: '#/components/schemas/ApprovalFilter' - title: ApprovalFilter - title: string | ApprovalFilter - default: never - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - - server_url - title: OpenAIResponseInputToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. - OpenAIResponseInputToolWebSearch: - properties: - type: - title: Type - default: web_search - type: string - enum: - - web_search - - web_search_preview - - web_search_preview_2025_03_11 - - web_search_2025_08_26 - search_context_size: - anyOf: - - type: string - pattern: ^low|medium|high$ - - type: 'null' - default: medium - type: object - title: OpenAIResponseInputToolWebSearch - description: Web search tool configuration for OpenAI response inputs. - OpenAIResponseMCPApprovalRequest: - properties: - arguments: - type: string - title: Arguments - id: - type: string - title: Id - name: - type: string - title: Name - server_label: - type: string - title: Server Label - type: - type: string - const: mcp_approval_request - title: Type - default: mcp_approval_request - type: object - required: - - arguments - - id - - name - - server_label - title: OpenAIResponseMCPApprovalRequest - description: A request for human approval of a tool invocation. - OpenAIResponseMCPApprovalResponse: - properties: - approval_request_id: - type: string - title: Approval Request Id - approve: - type: boolean - title: Approve - type: - type: string - const: mcp_approval_response - title: Type - default: mcp_approval_response - id: - anyOf: - - type: string - - type: 'null' - reason: - anyOf: - - type: string - - type: 'null' - type: object - required: - - approval_request_id - - approve - title: OpenAIResponseMCPApprovalResponse - description: A response to an MCP approval request. - OpenAIResponseMessage-Output: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseObject: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - created_at - - id - - model - - output - - status - title: OpenAIResponseObject - description: Complete OpenAI response object containing generation results and metadata. - OpenAIResponseObjectWithInput-Output: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - input: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Input - type: object - required: - - created_at - - id - - model - - output - - status - - input - title: OpenAIResponseObjectWithInput - description: OpenAI response object extended with input context information. - OpenAIResponseOutputMessageContentOutputText: - properties: - text: - type: string - title: Text - type: - type: string - const: output_text - title: Type - default: output_text - annotations: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - title: OpenAIResponseAnnotationFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - title: OpenAIResponseAnnotationContainerFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - title: OpenAIResponseAnnotationFilePath - discriminator: - propertyName: type - mapping: - container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' - url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - type: array - title: Annotations - type: object - required: - - text - title: OpenAIResponseOutputMessageContentOutputText - OpenAIResponseOutputMessageFileSearchToolCall: - properties: - id: - type: string - title: Id - queries: - items: - type: string - type: array - title: Queries - status: - type: string - title: Status - type: - type: string - const: file_search_call - title: Type - default: file_search_call - results: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' - type: array - - type: 'null' - type: object - required: - - id - - queries - - status - title: OpenAIResponseOutputMessageFileSearchToolCall - description: File search tool call output message for OpenAI responses. - OpenAIResponseOutputMessageFileSearchToolCallResults: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - text: - type: string - title: Text - type: object - required: - - attributes - - file_id - - filename - - score - - text - title: OpenAIResponseOutputMessageFileSearchToolCallResults - description: Search results returned by the file search operation. - OpenAIResponseOutputMessageFunctionToolCall: - properties: - call_id: - type: string - title: Call Id - name: - type: string - title: Name - arguments: - type: string - title: Arguments - type: - type: string - const: function_call - title: Type - default: function_call - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - name - - arguments - title: OpenAIResponseOutputMessageFunctionToolCall - description: Function tool call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPCall: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_call - title: Type - default: mcp_call - arguments: - type: string - title: Arguments - name: - type: string - title: Name - server_label: - type: string - title: Server Label - error: - anyOf: - - type: string - - type: 'null' - output: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - - arguments - - name - - server_label - title: OpenAIResponseOutputMessageMCPCall - description: Model Context Protocol (MCP) call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPListTools: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_list_tools - title: Type - default: mcp_list_tools - server_label: - type: string - title: Server Label - tools: - items: - $ref: '#/components/schemas/MCPListToolsTool' - type: array - title: Tools - type: object - required: - - id - - server_label - - tools - title: OpenAIResponseOutputMessageMCPListTools - description: MCP list tools output message containing available tools from an MCP server. - OpenAIResponseOutputMessageWebSearchToolCall: - properties: - id: - type: string - title: Id - status: - type: string - title: Status - type: - type: string - const: web_search_call - title: Type - default: web_search_call - type: object - required: - - id - - status - title: OpenAIResponseOutputMessageWebSearchToolCall - description: Web search tool call output message for OpenAI responses. - OpenAIResponsePrompt: - properties: - id: - type: string - title: Id - variables: - anyOf: - - additionalProperties: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: object - - type: 'null' - version: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - title: OpenAIResponsePrompt - description: OpenAI compatible Prompt object that is used in OpenAI responses. - OpenAIResponseText: - properties: - format: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseTextFormat' - title: OpenAIResponseTextFormat - - type: 'null' - title: OpenAIResponseTextFormat - type: object - title: OpenAIResponseText - description: Text response configuration for OpenAI responses. - OpenAIResponseTextFormat: - properties: - type: - title: Type - type: string - enum: - - text - - json_schema - - json_object - default: text - name: - anyOf: - - type: string - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - title: OpenAIResponseTextFormat - description: Configuration for Responses API text format. - OpenAIResponseToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - title: OpenAIResponseToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. - OpenAIResponseUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - output_tokens: - type: integer - title: Output Tokens - total_tokens: - type: integer - title: Total Tokens - input_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' - title: OpenAIResponseUsageInputTokensDetails - - type: 'null' - title: OpenAIResponseUsageInputTokensDetails - output_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' - title: OpenAIResponseUsageOutputTokensDetails - - type: 'null' - title: OpenAIResponseUsageOutputTokensDetails - type: object - required: - - input_tokens - - output_tokens - - total_tokens - title: OpenAIResponseUsage - description: Usage information for OpenAI response. - OpenAIResponseUsageInputTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageInputTokensDetails - description: Token details for input tokens in OpenAI response usage. - OpenAIResponseUsageOutputTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageOutputTokensDetails - description: Token details for output tokens in OpenAI response usage. - OpenAISystemMessageParam: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAISystemMessageParam - description: A system message providing instructions or context to the model. - OpenAITokenLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - top_logprobs: - items: - $ref: '#/components/schemas/OpenAITopLogProb' - type: array - title: Top Logprobs - type: object - required: - - token - - logprob - - top_logprobs - title: OpenAITokenLogProb - description: |- - The log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - :top_logprobs: The top log probabilities for the token - OpenAIToolMessageParam: - properties: - role: - type: string - const: tool - title: Role - default: tool - tool_call_id: - type: string - title: Tool Call Id - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - type: object - required: - - tool_call_id - - content - title: OpenAIToolMessageParam - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. - OpenAITopLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - type: object - required: - - token - - logprob - title: OpenAITopLogProb - description: |- - The top log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - OpenAIUserMessageParam-Input: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OpenAIUserMessageParam-Output: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OptimizerConfig: - properties: - optimizer_type: - $ref: '#/components/schemas/OptimizerType' - lr: - type: number - title: Lr - weight_decay: - type: number - title: Weight Decay - num_warmup_steps: - type: integer - title: Num Warmup Steps - type: object - required: - - optimizer_type - - lr - - weight_decay - - num_warmup_steps - title: OptimizerConfig - description: Configuration parameters for the optimization algorithm. - OptimizerType: - type: string - enum: - - adam - - adamw - - sgd - title: OptimizerType - description: Available optimizer algorithms for training. - OutputTokensDetails: - properties: - reasoning_tokens: - type: integer - title: Reasoning Tokens - additionalProperties: true - type: object - required: - - reasoning_tokens - title: OutputTokensDetails - PaginatedResponse: - properties: - data: - items: - additionalProperties: true - type: object - type: array - title: Data - has_more: - type: boolean - title: Has More - url: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - - has_more - title: PaginatedResponse - description: A generic paginated response that follows a simple format. - PostTrainingJob: - properties: - job_uuid: - type: string - title: Job Uuid - type: object - required: - - job_uuid - title: PostTrainingJob - PostTrainingJobArtifactsResponse: - properties: - job_uuid: - type: string - title: Job Uuid - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - title: PostTrainingJobArtifactsResponse - description: Artifacts of a finetuning job. - PostTrainingJobStatusResponse: - properties: - job_uuid: - type: string - title: Job Uuid - status: - $ref: '#/components/schemas/JobStatus' - scheduled_at: - anyOf: - - type: string - format: date-time - - type: 'null' - started_at: - anyOf: - - type: string - format: date-time - - type: 'null' - completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' - resources_allocated: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - - status - title: PostTrainingJobStatusResponse - description: Status of a finetuning job. - PostTrainingMetric: - properties: - epoch: - type: integer - title: Epoch - train_loss: - type: number - title: Train Loss - validation_loss: - type: number - title: Validation Loss - perplexity: - type: number - title: Perplexity - type: object - required: - - epoch - - train_loss - - validation_loss - - perplexity - title: PostTrainingMetric - description: Training metrics captured during post-training jobs. - Prompt: - properties: - prompt: - anyOf: - - type: string - - type: 'null' - description: The system prompt with variable placeholders - version: - type: integer - minimum: 1.0 - title: Version - description: Version (integer starting at 1, incremented on save) - prompt_id: - type: string - title: Prompt Id - description: Unique identifier in format 'pmpt_<48-digit-hash>' - variables: - items: - type: string - type: array - title: Variables - description: List of variable names that can be used in the prompt template - is_default: - type: boolean - title: Is Default - description: Boolean indicating whether this version is the default version - default: false - type: object - required: - - version - - prompt_id - title: Prompt - description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. - ProviderInfo: - properties: - api: - type: string - title: Api - provider_id: - type: string - title: Provider Id - provider_type: - type: string - title: Provider Type - config: - additionalProperties: true - type: object - title: Config - health: - additionalProperties: true - type: object - title: Health - type: object - required: - - api - - provider_id - - provider_type - - config - - health - title: ProviderInfo - description: Information about a registered provider including its configuration and health status. - QATFinetuningConfig: - properties: - type: - type: string - const: QAT - title: Type - default: QAT - quantizer_name: - type: string - title: Quantizer Name - group_size: - type: integer - title: Group Size - type: object - required: - - quantizer_name - - group_size - title: QATFinetuningConfig - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. - QueryChunksResponse: - properties: - chunks: - items: - $ref: '#/components/schemas/Chunk-Output' - type: array - title: Chunks - scores: - items: - type: number - type: array - title: Scores - type: object - required: - - chunks - - scores - title: QueryChunksResponse - description: Response from querying chunks in a vector database. - RegexParserScoringFnParams: - properties: - type: - type: string - const: regex_parser - title: Type - default: regex_parser - parsing_regexes: - items: - type: string - type: array - title: Parsing Regexes - description: Regex to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: RegexParserScoringFnParams - description: Parameters for regex parser scoring function configuration. - RerankData: - properties: - index: - type: integer - title: Index - relevance_score: - type: number - title: Relevance Score - type: object - required: - - index - - relevance_score - title: RerankData - description: A single rerank result from a reranking response. - RerankResponse: - properties: - data: - items: - $ref: '#/components/schemas/RerankData' - type: array - title: Data - type: object - required: - - data - title: RerankResponse - description: Response from a reranking request. - RouteInfo: - properties: - route: - type: string - title: Route - method: - type: string - title: Method - provider_types: - items: - type: string - type: array - title: Provider Types - type: object - required: - - route - - method - - provider_types - title: RouteInfo - description: Information about an API route including its path, method, and implementing providers. - RowsDataSource: - properties: - type: - type: string - const: rows - title: Type - default: rows - rows: - items: - additionalProperties: true - type: object - type: array - title: Rows - type: object - required: - - rows - title: RowsDataSource - description: A dataset stored in rows. - RunShieldResponse: - properties: - violation: - anyOf: - - $ref: '#/components/schemas/SafetyViolation' - title: SafetyViolation - - type: 'null' - title: SafetyViolation - type: object - title: RunShieldResponse - description: Response from running a safety shield. - SafetyViolation: - properties: - violation_level: - $ref: '#/components/schemas/ViolationLevel' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - violation_level - title: SafetyViolation - description: Details of a safety violation detected by content moderation. - SamplingParams: - properties: - strategy: - oneOf: - - $ref: '#/components/schemas/GreedySamplingStrategy' - title: GreedySamplingStrategy - - $ref: '#/components/schemas/TopPSamplingStrategy' - title: TopPSamplingStrategy - - $ref: '#/components/schemas/TopKSamplingStrategy' - title: TopKSamplingStrategy - title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy - discriminator: - propertyName: type - mapping: - greedy: '#/components/schemas/GreedySamplingStrategy' - top_k: '#/components/schemas/TopKSamplingStrategy' - top_p: '#/components/schemas/TopPSamplingStrategy' - max_tokens: - anyOf: - - type: integer - - type: 'null' - repetition_penalty: - anyOf: - - type: number - - type: 'null' - default: 1.0 - stop: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: SamplingParams - description: Sampling parameters. - ScoreBatchResponse: - properties: - dataset_id: - anyOf: - - type: string - - type: 'null' - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreBatchResponse - description: Response from batch scoring operations on datasets. - ScoreResponse: - properties: - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreResponse - description: The response from scoring. - ScoringFn: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: scoring_function - title: Type - default: scoring_function - description: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this definition - return_type: - oneOf: - - $ref: '#/components/schemas/StringType' - title: StringType - - $ref: '#/components/schemas/NumberType' - title: NumberType - - $ref: '#/components/schemas/BooleanType' - title: BooleanType - - $ref: '#/components/schemas/ArrayType' - title: ArrayType - - $ref: '#/components/schemas/ObjectType' - title: ObjectType - - $ref: '#/components/schemas/JsonType' - title: JsonType - - $ref: '#/components/schemas/UnionType' - title: UnionType - - $ref: '#/components/schemas/ChatCompletionInputType' - title: ChatCompletionInputType - - $ref: '#/components/schemas/CompletionInputType' - title: CompletionInputType - title: StringType | ... (9 variants) - description: The return type of the deterministic function - discriminator: - propertyName: type - mapping: - array: '#/components/schemas/ArrayType' - boolean: '#/components/schemas/BooleanType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - json: '#/components/schemas/JsonType' - number: '#/components/schemas/NumberType' - object: '#/components/schemas/ObjectType' - string: '#/components/schemas/StringType' - union: '#/components/schemas/UnionType' - params: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: Params - description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval - type: object - required: - - identifier - - provider_id - - return_type - title: ScoringFn - description: A scoring function resource for evaluating model outputs. - ScoringResult: - properties: - score_rows: - items: - additionalProperties: true - type: object - type: array - title: Score Rows - aggregated_results: - additionalProperties: true - type: object - title: Aggregated Results - type: object - required: - - score_rows - - aggregated_results - title: ScoringResult - description: A scoring result for a single row. - SearchRankingOptions: - properties: - ranker: - anyOf: - - type: string - - type: 'null' - score_threshold: - anyOf: - - type: number - - type: 'null' - default: 0.0 - type: object - title: SearchRankingOptions - description: Options for ranking and filtering search results. - Shield: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: shield - title: Type - default: shield - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: Shield - description: A safety shield resource that can be used to check content. - StringType: - properties: - type: - type: string - const: string - title: Type - default: string - type: object - title: StringType - description: Parameter type for string values. - SystemMessage: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - type: object - required: - - content - title: SystemMessage - description: A system message providing instructions or context to the model. - TextContentItem: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: TextContentItem - description: A text content item - ToolDef: - properties: - toolgroup_id: - anyOf: - - type: string - - type: 'null' - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - input_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - output_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - name - title: ToolDef - description: Tool definition used in runtime contexts. - ToolGroup: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: tool_group - title: Type - default: tool_group - mcp_endpoint: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - args: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: ToolGroup - description: A group of related tools managed together. - ToolInvocationResult: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - - type: 'null' - title: string | list[ImageContentItem-Output | TextContentItem] - error_message: - anyOf: - - type: string - - type: 'null' - error_code: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: ToolInvocationResult - description: Result of a tool invocation. - TopKSamplingStrategy: - properties: - type: - type: string - const: top_k - title: Type - default: top_k - top_k: - type: integer - minimum: 1.0 - title: Top K - type: object - required: - - top_k - title: TopKSamplingStrategy - description: Top-k sampling strategy that restricts sampling to the k most likely tokens. - TopPSamplingStrategy: - properties: - type: - type: string - const: top_p - title: Type - default: top_p - temperature: - anyOf: - - type: number - minimum: 0.0 - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - default: 0.95 - type: object - required: - - temperature - title: TopPSamplingStrategy - description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. - TrainingConfig: - properties: - n_epochs: - type: integer - title: N Epochs - max_steps_per_epoch: - type: integer - title: Max Steps Per Epoch - default: 1 - gradient_accumulation_steps: - type: integer - title: Gradient Accumulation Steps - default: 1 - max_validation_steps: - anyOf: - - type: integer - - type: 'null' - default: 1 - data_config: - anyOf: - - $ref: '#/components/schemas/DataConfig' - title: DataConfig - - type: 'null' - title: DataConfig - optimizer_config: - anyOf: - - $ref: '#/components/schemas/OptimizerConfig' - title: OptimizerConfig - - type: 'null' - title: OptimizerConfig - efficiency_config: - anyOf: - - $ref: '#/components/schemas/EfficiencyConfig' - title: EfficiencyConfig - - type: 'null' - title: EfficiencyConfig - dtype: - anyOf: - - type: string - - type: 'null' - default: bf16 - type: object - required: - - n_epochs - title: TrainingConfig - description: Comprehensive configuration for the training process. - URIDataSource: - properties: - type: - type: string - const: uri - title: Type - default: uri - uri: - type: string - title: Uri - type: object - required: - - uri - title: URIDataSource - description: A dataset that can be obtained from a URI. - URL: - properties: - uri: - type: string - title: Uri - type: object - required: - - uri - title: URL - description: A URL reference to external content. - UnionType: - properties: - type: - type: string - const: union - title: Type - default: union - type: object - title: UnionType - description: Parameter type for union values. - VectorStoreChunkingStrategyAuto: - properties: - type: - type: string - const: auto - title: Type - default: auto - type: object - title: VectorStoreChunkingStrategyAuto - description: Automatic chunking strategy for vector store files. - VectorStoreChunkingStrategyStatic: - properties: - type: - type: string - const: static - title: Type - default: static - static: - $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - type: object - required: - - static - title: VectorStoreChunkingStrategyStatic - description: Static chunking strategy with configurable parameters. - VectorStoreChunkingStrategyStaticConfig: - properties: - chunk_overlap_tokens: - type: integer - title: Chunk Overlap Tokens - default: 400 - max_chunk_size_tokens: - type: integer - maximum: 4096.0 - minimum: 100.0 - title: Max Chunk Size Tokens - default: 800 - type: object - title: VectorStoreChunkingStrategyStaticConfig - description: Configuration for static chunking strategy. - VectorStoreContent: - properties: - type: - type: string - const: text - title: Type - text: - type: string - title: Text - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - type - - text - title: VectorStoreContent - description: Content item from a vector store file or search result. - VectorStoreDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreDeleteResponse - description: Response from deleting a vector store. - VectorStoreFileBatchObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file_batch - created_at: - type: integer - title: Created At - vector_store_id: - type: string - title: Vector Store Id - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - type: object - required: - - id - - created_at - - vector_store_id - - status - - file_counts - title: VectorStoreFileBatchObject - description: OpenAI Vector Store File Batch object. - VectorStoreFileContentResponse: - properties: - object: - type: string - const: vector_store.file_content.page - title: Object - default: vector_store.file_content.page - data: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - title: VectorStoreFileContentResponse - description: Represents the parsed content of a vector store file. - VectorStoreFileCounts: - properties: - completed: - type: integer - title: Completed - cancelled: - type: integer - title: Cancelled - failed: - type: integer - title: Failed - in_progress: - type: integer - title: In Progress - total: - type: integer - title: Total - type: object - required: - - completed - - cancelled - - failed - - in_progress - - total - title: VectorStoreFileCounts - description: File processing status counts for a vector store. - VectorStoreFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreFileDeleteResponse - description: Response from deleting a vector store file. - VectorStoreFileLastError: - properties: - code: - title: Code - type: string - enum: - - server_error - - rate_limit_exceeded - default: server_error - message: - type: string - title: Message - type: object - required: - - code - - message - title: VectorStoreFileLastError - description: Error information for failed vector store file processing. - VectorStoreFileObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file - attributes: - additionalProperties: true - type: object - title: Attributes - chunking_strategy: - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - created_at: - type: integer - title: Created At - last_error: - anyOf: - - $ref: '#/components/schemas/VectorStoreFileLastError' - title: VectorStoreFileLastError - - type: 'null' - title: VectorStoreFileLastError - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - vector_store_id: - type: string - title: Vector Store Id - type: object - required: - - id - - chunking_strategy - - created_at - - status - - vector_store_id - title: VectorStoreFileObject - description: OpenAI Vector Store File object. - VectorStoreFilesListInBatchResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreFilesListInBatchResponse - description: Response from listing files in a vector store file batch. - VectorStoreListFilesResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListFilesResponse - description: Response from listing files in a vector store. - VectorStoreListResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListResponse - description: Response from listing vector stores. - VectorStoreObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store - created_at: - type: integer - title: Created At - name: - anyOf: - - type: string - - type: 'null' - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - status: - type: string - title: Status - default: completed - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - last_active_at: - anyOf: - - type: integer - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - id - - created_at - - file_counts - title: VectorStoreObject - description: OpenAI Vector Store object. - VectorStoreSearchResponse-Output: - properties: - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - attributes: - anyOf: - - additionalProperties: - anyOf: - - type: string - - type: number - - type: boolean - title: string | number | boolean - type: object - - type: 'null' - content: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Content - type: object - required: - - file_id - - filename - - score - - content - title: VectorStoreSearchResponse - description: Response from searching a vector store. - VectorStoreSearchResponsePage: - properties: - object: - type: string - title: Object - default: vector_store.search_results.page - search_query: - items: - type: string - type: array - title: Search Query - data: - items: - $ref: '#/components/schemas/VectorStoreSearchResponse-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - search_query - - data - title: VectorStoreSearchResponsePage - description: Paginated response from searching a vector store. - VersionInfo: - properties: - version: - type: string - title: Version - type: object - required: - - version - title: VersionInfo - description: Version information for the service. - ViolationLevel: - type: string - enum: - - info - - warn - - error - title: ViolationLevel - description: Severity level of a safety violation. - _URLOrData: - properties: - url: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - data: - anyOf: - - type: string - - type: 'null' - contentEncoding: base64 - type: object - title: _URLOrData - description: A URL or a base64 encoded string - _eval_benchmarks_benchmark_id_evaluations_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - benchmark_config: - $ref: '#/components/schemas/BenchmarkConfig' - type: object - required: - - input_rows - - scoring_functions - - benchmark_config - title: _eval_benchmarks_benchmark_id_evaluations_Request - _inference_rerank_Request: - properties: - model: - type: string - title: Model - query: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - items: - items: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - type: array - title: Items - max_num_results: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - model - - query - - items - title: _inference_rerank_Request - _post_training_preference_optimize_Request: - properties: - job_uuid: - type: string - title: Job Uuid - finetuned_model: - type: string - title: Finetuned Model - algorithm_config: - $ref: '#/components/schemas/DPOAlignmentConfig' - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - type: object - required: - - job_uuid - - finetuned_model - - algorithm_config - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_preference_optimize_Request - _post_training_supervised_fine_tune_Request: - properties: - job_uuid: - type: string - title: Job Uuid - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - model: - anyOf: - - type: string - - type: 'null' - description: Model descriptor for training if not in provider config` - checkpoint_dir: - anyOf: - - type: string - - type: 'null' - algorithm_config: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LoraFinetuningConfig' - title: LoraFinetuningConfig - - $ref: '#/components/schemas/QATFinetuningConfig' - title: QATFinetuningConfig - discriminator: - propertyName: type - mapping: - LoRA: '#/components/schemas/LoraFinetuningConfig' - QAT: '#/components/schemas/QATFinetuningConfig' - title: LoraFinetuningConfig | QATFinetuningConfig - - type: 'null' - title: Algorithm Config - type: object - required: - - job_uuid - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_supervised_fine_tune_Request - Error: - description: Error response from the API. Roughly follows RFC 7807. - properties: - status: - title: Status - type: integer - title: - title: Title - type: string - detail: - title: Detail - type: string - instance: - anyOf: - - type: string - - type: 'null' - nullable: true - required: - - status - - title - - detail - title: Error - type: object ImageContentItem: description: A image content item properties: @@ -5873,6 +578,49 @@ components: - image title: ImageContentItem type: object + TextContentItem: + description: A text content item + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextContentItem + type: object + URL: + description: A URL reference to external content. + properties: + uri: + title: Uri + type: string + required: + - uri + title: URL + type: object + _URLOrData: + description: A URL or a base64 encoded string + properties: + url: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + data: + anyOf: + - type: string + - type: 'null' + contentEncoding: base64 + nullable: true + title: _URLOrData + type: object InterleavedContentItem: discriminator: mapping: @@ -5914,110 +662,54 @@ components: type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] - BuiltinTool: - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - title: BuiltinTool - type: string - ImageDelta: - description: An image content delta for streaming responses. + GreedySamplingStrategy: + description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: - const: image - default: image + const: greedy + default: greedy title: Type type: string - image: - format: binary - title: Image - type: string - required: - - image - title: ImageDelta + title: GreedySamplingStrategy type: object - TextDelta: - description: A text content delta for streaming responses. + TopKSamplingStrategy: + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: - const: text - default: text + const: top_k + default: top_k title: Type type: string - text: - title: Text - type: string + top_k: + minimum: 1 + title: Top K + type: integer required: - - text - title: TextDelta + - top_k + title: TopKSamplingStrategy type: object - ToolCall: + TopPSamplingStrategy: + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: - call_id: - title: Call Id + type: + const: top_p + default: top_p + title: Type type: string - tool_name: + temperature: anyOf: - - $ref: '#/components/schemas/BuiltinTool' - title: BuiltinTool - - type: string - title: BuiltinTool | string - arguments: - title: Arguments - type: string - required: - - call_id - - tool_name - - arguments - title: ToolCall - type: object - ToolCallDelta: - description: A tool call content delta for streaming responses. - properties: - type: - const: tool_call - default: tool_call - title: Type - type: string - tool_call: + - type: number + minimum: 0.0 + - type: 'null' + top_p: anyOf: - - type: string - - $ref: '#/components/schemas/ToolCall' - title: ToolCall - title: string | ToolCall - parse_status: - $ref: '#/components/schemas/ToolCallParseStatus' + - type: number + - type: 'null' + default: 0.95 required: - - tool_call - - parse_status - title: ToolCallDelta + - temperature + title: TopPSamplingStrategy type: object - ToolCallParseStatus: - description: Status of tool call parsing during streaming. - enum: - - started - - in_progress - - failed - - succeeded - title: ToolCallParseStatus - type: string - ContentDelta: - discriminator: - mapping: - image: '#/components/schemas/ImageDelta' - text: '#/components/schemas/TextDelta' - tool_call: '#/components/schemas/ToolCallDelta' - propertyName: type - oneOf: - - $ref: '#/components/schemas/TextDelta' - title: TextDelta - - $ref: '#/components/schemas/ImageDelta' - title: ImageDelta - - $ref: '#/components/schemas/ToolCallDelta' - title: ToolCallDelta - title: TextDelta | ImageDelta | ToolCallDelta SamplingStrategy: discriminator: mapping: @@ -6077,6 +769,82 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat + OpenAIChatCompletionContentPartImageParam: + description: Image content part for OpenAI-compatible chat completion messages. + properties: + type: + const: image_url + default: image_url + title: Type + type: string + image_url: + $ref: '#/components/schemas/OpenAIImageURL' + required: + - image_url + title: OpenAIChatCompletionContentPartImageParam + type: object + OpenAIChatCompletionContentPartTextParam: + description: Text content part for OpenAI-compatible chat completion messages. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: OpenAIChatCompletionContentPartTextParam + type: object + OpenAIFile: + properties: + type: + const: file + default: file + title: Type + type: string + file: + $ref: '#/components/schemas/OpenAIFileFile' + required: + - file + title: OpenAIFile + type: object + OpenAIFileFile: + properties: + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIFileFile + type: object + OpenAIImageURL: + description: Image URL specification for OpenAI-compatible chat completion messages. + properties: + url: + title: Url + type: string + detail: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - url + title: OpenAIImageURL + type: object OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -6124,6 +892,122 @@ components: nullable: true title: OpenAIAssistantMessageParam type: object + OpenAIChatCompletionToolCall: + description: Tool call specification for OpenAI-compatible chat completion responses. + properties: + index: + anyOf: + - type: integer + - type: 'null' + nullable: true + id: + anyOf: + - type: string + - type: 'null' + nullable: true + type: + const: function + default: function + title: Type + type: string + function: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' + title: OpenAIChatCompletionToolCallFunction + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + title: OpenAIChatCompletionToolCall + type: object + OpenAIChatCompletionToolCallFunction: + description: Function call details for OpenAI-compatible tool calls. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + arguments: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + type: object + OpenAIDeveloperMessageParam: + description: A message from the developer in an OpenAI-compatible chat completion request. + properties: + role: + const: developer + default: developer + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAIDeveloperMessageParam + type: object + OpenAISystemMessageParam: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAISystemMessageParam + type: object + OpenAIToolMessageParam: + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. + properties: + role: + const: tool + default: tool + title: Role + type: string + tool_call_id: + title: Tool Call Id + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + required: + - tool_call_id + - content + title: OpenAIToolMessageParam + type: object OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -6183,6 +1067,61 @@ components: - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) + OpenAIJSONSchema: + description: JSON schema specification for OpenAI-compatible structured response format. + properties: + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + title: OpenAIJSONSchema + type: object + OpenAIResponseFormatJSONObject: + description: JSON object response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_object + default: json_object + title: Type + type: string + title: OpenAIResponseFormatJSONObject + type: object + OpenAIResponseFormatJSONSchema: + description: JSON schema response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_schema + default: json_schema + title: Type + type: string + json_schema: + $ref: '#/components/schemas/OpenAIJSONSchema' + required: + - json_schema + title: OpenAIResponseFormatJSONSchema + type: object + OpenAIResponseFormatText: + description: Text response format for OpenAI-compatible chat completion requests. + properties: + type: + const: text + default: text + title: Type + type: string + title: OpenAIResponseFormatText + type: object OpenAIResponseFormatParam: discriminator: mapping: @@ -6198,6 +1137,45 @@ components: - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + VectorStoreChunkingStrategyAuto: + description: Automatic chunking strategy for vector store files. + properties: + type: + const: auto + default: auto + title: Type + type: string + title: VectorStoreChunkingStrategyAuto + type: object + VectorStoreChunkingStrategyStatic: + description: Static chunking strategy with configurable parameters. + properties: + type: + const: static + default: static + title: Type + type: string + static: + $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + required: + - static + title: VectorStoreChunkingStrategyStatic + type: object + VectorStoreChunkingStrategyStaticConfig: + description: Configuration for static chunking strategy. + properties: + chunk_overlap_tokens: + default: 400 + title: Chunk Overlap Tokens + type: integer + max_chunk_size_tokens: + default: 800 + maximum: 4096 + minimum: 100 + title: Max Chunk Size Tokens + type: integer + title: VectorStoreChunkingStrategyStaticConfig + type: object VectorStoreChunkingStrategy: discriminator: mapping: @@ -6218,6 +1196,79 @@ components: - cancelled - failed default: completed + OpenAIResponseInputMessageContentFile: + description: File content for input messages in OpenAI response format. + properties: + type: + const: input_file + default: input_file + title: Type + type: string + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + file_url: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentFile + type: object + OpenAIResponseInputMessageContentImage: + description: Image content for input messages in OpenAI response format. + properties: + detail: + default: auto + title: Detail + type: string + enum: + - low + - high + - auto + type: + const: input_image + default: input_image + title: Type + type: string + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + image_url: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentImage + type: object + OpenAIResponseInputMessageContentText: + description: Text content for input messages in OpenAI response format. + properties: + text: + title: Text + type: string + type: + const: input_text + default: input_text + title: Type + type: string + required: + - text + title: OpenAIResponseInputMessageContentText + type: object OpenAIResponseInputMessageContent: discriminator: mapping: @@ -6233,6 +1284,104 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + OpenAIResponseAnnotationCitation: + description: URL citation annotation for referencing external web resources. + properties: + type: + const: url_citation + default: url_citation + title: Type + type: string + end_index: + title: End Index + type: integer + start_index: + title: Start Index + type: integer + title: + title: Title + type: string + url: + title: Url + type: string + required: + - end_index + - start_index + - title + - url + title: OpenAIResponseAnnotationCitation + type: object + OpenAIResponseAnnotationContainerFileCitation: + properties: + type: + const: container_file_citation + default: container_file_citation + title: Type + type: string + container_id: + title: Container Id + type: string + end_index: + title: End Index + type: integer + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + start_index: + title: Start Index + type: integer + required: + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation + type: object + OpenAIResponseAnnotationFileCitation: + description: File citation annotation for referencing specific files in response content. + properties: + type: + const: file_citation + default: file_citation + title: Type + type: string + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + index: + title: Index + type: integer + required: + - file_id + - filename + - index + title: OpenAIResponseAnnotationFileCitation + type: object + OpenAIResponseAnnotationFilePath: + properties: + type: + const: file_path + default: file_path + title: Type + type: string + file_id: + title: File Id + type: string + index: + title: Index + type: integer + required: + - file_id + - index + title: OpenAIResponseAnnotationFilePath + type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -6251,6 +1400,56 @@ components: - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + OpenAIResponseContentPartRefusal: + description: Refusal content within a streamed response part. + properties: + type: + const: refusal + default: refusal + title: Type + type: string + refusal: + title: Refusal + type: string + required: + - refusal + title: OpenAIResponseContentPartRefusal + type: object + OpenAIResponseOutputMessageContentOutputText: + properties: + text: + title: Text + type: string + type: + const: output_text + default: output_text + title: Type + type: string + annotations: + items: + discriminator: + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + title: OpenAIResponseAnnotationFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + title: OpenAIResponseAnnotationCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + title: OpenAIResponseAnnotationContainerFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + title: OpenAIResponseAnnotationFilePath + title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + title: Annotations + type: array + required: + - text + title: OpenAIResponseOutputMessageContentOutputText + type: object OpenAIResponseOutputMessageContent: discriminator: mapping: @@ -6263,6 +1462,53 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal + MCPListToolsTool: + description: Tool definition returned by MCP list tools operation. + properties: + input_schema: + additionalProperties: true + title: Input Schema + type: object + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - input_schema + - name + title: MCPListToolsTool + type: object + OpenAIResponseMCPApprovalRequest: + description: A request for human approval of a tool invocation. + properties: + arguments: + title: Arguments + type: string + id: + title: Id + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + type: + const: mcp_approval_request + default: mcp_approval_request + title: Type + type: string + required: + - arguments + - id + - name + - server_label + title: OpenAIResponseMCPApprovalRequest + type: object OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -6334,6 +1580,179 @@ components: - role title: OpenAIResponseMessage type: object + OpenAIResponseOutputMessageFileSearchToolCall: + description: File search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + queries: + items: + type: string + title: Queries + type: array + status: + title: Status + type: string + type: + const: file_search_call + default: file_search_call + title: Type + type: string + results: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' + type: array + - type: 'null' + nullable: true + required: + - id + - queries + - status + title: OpenAIResponseOutputMessageFileSearchToolCall + type: object + OpenAIResponseOutputMessageFileSearchToolCallResults: + description: Search results returned by the file search operation. + properties: + attributes: + additionalProperties: true + title: Attributes + type: object + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + score: + title: Score + type: number + text: + title: Text + type: string + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + type: object + OpenAIResponseOutputMessageFunctionToolCall: + description: Function tool call output message for OpenAI responses. + properties: + call_id: + title: Call Id + type: string + name: + title: Name + type: string + arguments: + title: Arguments + type: string + type: + const: function_call + default: function_call + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - name + - arguments + title: OpenAIResponseOutputMessageFunctionToolCall + type: object + OpenAIResponseOutputMessageMCPCall: + description: Model Context Protocol (MCP) call output message for OpenAI responses. + properties: + id: + title: Id + type: string + type: + const: mcp_call + default: mcp_call + title: Type + type: string + arguments: + title: Arguments + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + error: + anyOf: + - type: string + - type: 'null' + nullable: true + output: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + - arguments + - name + - server_label + title: OpenAIResponseOutputMessageMCPCall + type: object + OpenAIResponseOutputMessageMCPListTools: + description: MCP list tools output message containing available tools from an MCP server. + properties: + id: + title: Id + type: string + type: + const: mcp_list_tools + default: mcp_list_tools + title: Type + type: string + server_label: + title: Server Label + type: string + tools: + items: + $ref: '#/components/schemas/MCPListToolsTool' + title: Tools + type: array + required: + - id + - server_label + - tools + title: OpenAIResponseOutputMessageMCPListTools + type: object + OpenAIResponseOutputMessageWebSearchToolCall: + description: Web search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + status: + title: Status + type: string + type: + const: web_search_call + default: web_search_call + title: Type + type: string + required: + - id + - status + title: OpenAIResponseOutputMessageWebSearchToolCall + type: object OpenAIResponseOutput: discriminator: mapping: @@ -6361,6 +1780,186 @@ components: - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) + AllowedToolsFilter: + description: Filter configuration for restricting which MCP tools can be used. + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: AllowedToolsFilter + type: object + ApprovalFilter: + description: Filter configuration for MCP tool approval requirements. + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: ApprovalFilter + type: object + OpenAIResponseInputToolFileSearch: + description: File search tool configuration for OpenAI response inputs. + properties: + type: + const: file_search + default: file_search + title: Type + type: string + vector_store_ids: + items: + type: string + title: Vector Store Ids + type: array + filters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + max_num_results: + anyOf: + - maximum: 50 + minimum: 1 + type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + nullable: true + title: SearchRankingOptions + required: + - vector_store_ids + title: OpenAIResponseInputToolFileSearch + type: object + OpenAIResponseInputToolFunction: + description: Function tool configuration for OpenAI response inputs. + properties: + type: + const: function + default: function + title: Type + type: string + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + parameters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + nullable: true + required: + - name + - parameters + title: OpenAIResponseInputToolFunction + type: object + OpenAIResponseInputToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + server_url: + title: Server Url + type: string + headers: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + require_approval: + anyOf: + - const: always + type: string + - const: never + type: string + - $ref: '#/components/schemas/ApprovalFilter' + title: ApprovalFilter + default: never + title: string | ApprovalFilter + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + - server_url + title: OpenAIResponseInputToolMCP + type: object + OpenAIResponseInputToolWebSearch: + description: Web search tool configuration for OpenAI response inputs. + properties: + type: + default: web_search + title: Type + type: string + enum: + - web_search + - web_search_preview + - web_search_preview_2025_03_11 + - web_search_2025_08_26 + search_context_size: + anyOf: + - pattern: ^low|medium|high$ + type: string + - type: 'null' + default: medium + title: OpenAIResponseInputToolWebSearch + type: object + SearchRankingOptions: + description: Options for ranking and filtering search results. + properties: + ranker: + anyOf: + - type: string + - type: 'null' + nullable: true + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + title: SearchRankingOptions + type: object OpenAIResponseInputTool: discriminator: mapping: @@ -6382,6 +1981,32 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) + OpenAIResponseToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + title: OpenAIResponseToolMCP + type: object OpenAIResponseTool: discriminator: mapping: @@ -6492,6 +2117,164 @@ components: - text title: OpenAIResponseContentPartReasoningSummary type: object + OpenAIResponseError: + description: Error details for failed OpenAI response requests. + properties: + code: + title: Code + type: string + message: + title: Message + type: string + required: + - code + - message + title: OpenAIResponseError + type: object + OpenAIResponseObject: + description: Complete OpenAI response object containing generation results and metadata. + properties: + created_at: + title: Created At + type: integer + error: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseError' + title: OpenAIResponseError + - type: 'null' + nullable: true + title: OpenAIResponseError + id: + title: Id + type: string + model: + title: Model + type: string + object: + const: response + default: response + title: Object + type: string + output: + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + title: Output + type: array + parallel_tool_calls: + default: false + title: Parallel Tool Calls + type: boolean + previous_response_id: + anyOf: + - type: string + - type: 'null' + nullable: true + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + nullable: true + title: OpenAIResponsePrompt + status: + title: Status + type: string + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + text: + $ref: '#/components/schemas/OpenAIResponseText' + default: + format: + type: text + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + tools: + anyOf: + - items: + discriminator: + mapping: + file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' + function: '#/components/schemas/OpenAIResponseInputToolFunction' + mcp: '#/components/schemas/OpenAIResponseToolMCP' + web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + title: OpenAIResponseInputToolWebSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + title: OpenAIResponseInputToolFileSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + title: OpenAIResponseInputToolFunction + - $ref: '#/components/schemas/OpenAIResponseToolMCP' + title: OpenAIResponseToolMCP + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + nullable: true + truncation: + anyOf: + - type: string + - type: 'null' + nullable: true + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsage' + title: OpenAIResponseUsage + - type: 'null' + nullable: true + title: OpenAIResponseUsage + instructions: + anyOf: + - type: string + - type: 'null' + nullable: true + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + nullable: true + required: + - created_at + - id + - model + - output + - status + title: OpenAIResponseObject + type: object OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: @@ -7466,6 +3249,135 @@ components: - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object + OpenAIResponsePrompt: + description: OpenAI compatible Prompt object that is used in OpenAI responses. + properties: + id: + title: Id + type: string + variables: + anyOf: + - additionalProperties: + discriminator: + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: object + - type: 'null' + nullable: true + version: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + title: OpenAIResponsePrompt + type: object + OpenAIResponseText: + description: Text response configuration for OpenAI responses. + properties: + format: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseTextFormat' + title: OpenAIResponseTextFormat + - type: 'null' + nullable: true + title: OpenAIResponseTextFormat + title: OpenAIResponseText + type: object + OpenAIResponseTextFormat: + description: Configuration for Responses API text format. + properties: + type: + title: Type + type: string + enum: + - text + - json_schema + - json_object + default: text + name: + anyOf: + - type: string + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + title: OpenAIResponseTextFormat + type: object + OpenAIResponseUsage: + description: Usage information for OpenAI response. + properties: + input_tokens: + title: Input Tokens + type: integer + output_tokens: + title: Output Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + input_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' + title: OpenAIResponseUsageInputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + output_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' + title: OpenAIResponseUsageOutputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + required: + - input_tokens + - output_tokens + - total_tokens + title: OpenAIResponseUsage + type: object + OpenAIResponseUsageInputTokensDetails: + description: Token details for input tokens in OpenAI response usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + type: object + OpenAIResponseUsageOutputTokensDetails: + description: Token details for output tokens in OpenAI response usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + type: object OpenAIResponseObjectStream: discriminator: mapping: @@ -7580,6 +3492,64 @@ components: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) + OpenAIResponseInputFunctionToolCallOutput: + description: This represents the output of a function call that gets passed back to the model. + properties: + call_id: + title: Call Id + type: string + output: + title: Output + type: string + type: + const: function_call_output + default: function_call_output + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - output + title: OpenAIResponseInputFunctionToolCallOutput + type: object + OpenAIResponseMCPApprovalResponse: + description: A response to an MCP approval request. + properties: + approval_request_id: + title: Approval Request Id + type: string + approve: + title: Approve + type: boolean + type: + const: mcp_approval_response + default: mcp_approval_response + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + reason: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - approval_request_id + - approve + title: OpenAIResponseMCPApprovalResponse + type: object OpenAIResponseInput: anyOf: - discriminator: @@ -7615,51 +3585,96 @@ components: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage - ConversationItem: - discriminator: - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - propertyName: type - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - title: OpenAIResponseMessage - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - DataSource: - discriminator: - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - propertyName: type - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource + ArrayType: + description: Parameter type for array values. + properties: + type: + const: array + default: array + title: Type + type: string + title: ArrayType + type: object + BooleanType: + description: Parameter type for boolean values. + properties: + type: + const: boolean + default: boolean + title: Type + type: string + title: BooleanType + type: object + ChatCompletionInputType: + description: Parameter type for chat completion input. + properties: + type: + const: chat_completion_input + default: chat_completion_input + title: Type + type: string + title: ChatCompletionInputType + type: object + CompletionInputType: + description: Parameter type for completion input. + properties: + type: + const: completion_input + default: completion_input + title: Type + type: string + title: CompletionInputType + type: object + JsonType: + description: Parameter type for JSON values. + properties: + type: + const: json + default: json + title: Type + type: string + title: JsonType + type: object + NumberType: + description: Parameter type for numeric values. + properties: + type: + const: number + default: number + title: Type + type: string + title: NumberType + type: object + ObjectType: + description: Parameter type for object values. + properties: + type: + const: object + default: object + title: Type + type: string + title: ObjectType + type: object + StringType: + description: Parameter type for string values. + properties: + type: + const: string + default: string + title: Type + type: string + title: StringType + type: object + UnionType: + description: Parameter type for union values. + properties: + type: + const: union + default: union + title: Type + type: string + title: UnionType + type: object ParamType: discriminator: mapping: @@ -7693,6 +3708,164 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + ConversationItem: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + RowsDataSource: + description: A dataset stored in rows. + properties: + type: + const: rows + default: rows + title: Type + type: string + rows: + items: + additionalProperties: true + type: object + title: Rows + type: array + required: + - rows + title: RowsDataSource + type: object + URIDataSource: + description: A dataset that can be obtained from a URI. + properties: + type: + const: uri + default: uri + title: Type + type: string + uri: + title: Uri + type: string + required: + - uri + title: URIDataSource + type: object + DataSource: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + AggregationFunctionType: + description: Types of aggregation functions for scoring results. + enum: + - average + - weighted_average + - median + - categorical_count + - accuracy + title: AggregationFunctionType + type: string + BasicScoringFnParams: + description: Parameters for basic scoring function configuration. + properties: + type: + const: basic + default: basic + title: Type + type: string + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: BasicScoringFnParams + type: object + LLMAsJudgeScoringFnParams: + description: Parameters for LLM-as-judge scoring function configuration. + properties: + type: + const: llm_as_judge + default: llm_as_judge + title: Type + type: string + judge_model: + title: Judge Model + type: string + prompt_template: + anyOf: + - type: string + - type: 'null' + nullable: true + judge_score_regexes: + description: Regexes to extract the answer from generated response + items: + type: string + title: Judge Score Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + required: + - judge_model + title: LLMAsJudgeScoringFnParams + type: object + RegexParserScoringFnParams: + description: Parameters for regex parser scoring function configuration. + properties: + type: + const: regex_parser + default: regex_parser + title: Type + type: string + parsing_regexes: + description: Regex to extract the answer from generated response + items: + type: string + title: Parsing Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: RegexParserScoringFnParams + type: object ScoringFnParams: discriminator: mapping: @@ -7708,6 +3881,68 @@ components: - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + LoraFinetuningConfig: + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. + properties: + type: + const: LoRA + default: LoRA + title: Type + type: string + lora_attn_modules: + items: + type: string + title: Lora Attn Modules + type: array + apply_lora_to_mlp: + title: Apply Lora To Mlp + type: boolean + apply_lora_to_output: + title: Apply Lora To Output + type: boolean + rank: + title: Rank + type: integer + alpha: + title: Alpha + type: integer + use_dora: + anyOf: + - type: boolean + - type: 'null' + default: false + quantize_base: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + title: LoraFinetuningConfig + type: object + QATFinetuningConfig: + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. + properties: + type: + const: QAT + default: QAT + title: Type + type: string + quantizer_name: + title: Quantizer Name + type: string + group_size: + title: Group Size + type: integer + required: + - quantizer_name + - group_size + title: QATFinetuningConfig + type: object AlgorithmConfig: discriminator: mapping: @@ -7941,15 +4176,55 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - ResponseGuardrailSpec: - description: Specification for a guardrail to apply during response generation. + ListOpenAIResponseInputItem: + description: List container for OpenAI response input items. properties: - type: - title: Type + data: + items: + anyOf: + - discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage + title: Data + type: array + object: + const: list + default: list + title: Object type: string required: - - type - title: ResponseGuardrailSpec + - data + title: ListOpenAIResponseInputItem type: object OpenAIResponseObjectWithInput: description: OpenAI response object extended with input context information. @@ -8134,6 +4409,426 @@ components: - input title: OpenAIResponseObjectWithInput type: object + ListOpenAIResponseObject: + description: Paginated list of OpenAI response objects with navigation metadata. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIResponseObjectWithInput' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIResponseObject + type: object + OpenAIDeleteResponseObject: + description: Response object confirming deletion of an OpenAI response. + properties: + id: + title: Id + type: string + object: + const: response + default: response + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: OpenAIDeleteResponseObject + type: object + ResponseGuardrailSpec: + description: Specification for a guardrail to apply during response generation. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + Batch: + additionalProperties: true + properties: + id: + title: Id + type: string + completion_window: + title: Completion Window + type: string + created_at: + title: Created At + type: integer + endpoint: + title: Endpoint + type: string + input_file_id: + title: Input File Id + type: string + object: + const: batch + title: Object + type: string + status: + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + title: Status + type: string + cancelled_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + cancelling_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + completed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + error_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + errors: + anyOf: + - $ref: '#/components/schemas/Errors' + title: Errors + - type: 'null' + nullable: true + title: Errors + expired_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + failed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + finalizing_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + in_progress_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + nullable: true + model: + anyOf: + - type: string + - type: 'null' + nullable: true + output_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + request_counts: + anyOf: + - $ref: '#/components/schemas/BatchRequestCounts' + title: BatchRequestCounts + - type: 'null' + nullable: true + title: BatchRequestCounts + usage: + anyOf: + - $ref: '#/components/schemas/BatchUsage' + title: BatchUsage + - type: 'null' + nullable: true + title: BatchUsage + required: + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status + title: Batch + type: object + BatchError: + additionalProperties: true + properties: + code: + anyOf: + - type: string + - type: 'null' + nullable: true + line: + anyOf: + - type: integer + - type: 'null' + nullable: true + message: + anyOf: + - type: string + - type: 'null' + nullable: true + param: + anyOf: + - type: string + - type: 'null' + nullable: true + title: BatchError + type: object + BatchRequestCounts: + additionalProperties: true + properties: + completed: + title: Completed + type: integer + failed: + title: Failed + type: integer + total: + title: Total + type: integer + required: + - completed + - failed + - total + title: BatchRequestCounts + type: object + BatchUsage: + additionalProperties: true + properties: + input_tokens: + title: Input Tokens + type: integer + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + title: Output Tokens + type: integer + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + title: Total Tokens + type: integer + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + type: object + Errors: + additionalProperties: true + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + nullable: true + object: + anyOf: + - type: string + - type: 'null' + nullable: true + title: Errors + type: object + InputTokensDetails: + additionalProperties: true + properties: + cached_tokens: + title: Cached Tokens + type: integer + required: + - cached_tokens + title: InputTokensDetails + type: object + OutputTokensDetails: + additionalProperties: true + properties: + reasoning_tokens: + title: Reasoning Tokens + type: integer + required: + - reasoning_tokens + title: OutputTokensDetails + type: object + ListBatchesResponse: + description: Response containing a list of batch objects. + properties: + object: + const: list + default: list + title: Object + type: string + data: + description: List of batch objects + items: + $ref: '#/components/schemas/Batch' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: ID of the first batch in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: ID of the last batch in the list + nullable: true + has_more: + default: false + description: Whether there are more batches available + title: Has More + type: boolean + required: + - data + title: ListBatchesResponse + type: object + Benchmark: + description: A benchmark resource for evaluating model performance. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: benchmark + default: benchmark + title: Type + type: string + dataset_id: + title: Dataset Id + type: string + scoring_functions: + items: + type: string + title: Scoring Functions + type: array + metadata: + additionalProperties: true + description: Metadata for this evaluation task + title: Metadata + type: object + required: + - identifier + - provider_id + - dataset_id + - scoring_functions + title: Benchmark + type: object + ImageDelta: + description: An image content delta for streaming responses. + properties: + type: + const: image + default: image + title: Type + type: string + image: + format: binary + title: Image + type: string + required: + - image + title: ImageDelta + type: object + TextDelta: + description: A text content delta for streaming responses. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextDelta + type: object + JobStatus: + description: Status of a job execution. + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + type: string + Job: + description: A job execution instance with status tracking. + properties: + job_id: + title: Job Id + type: string + status: + $ref: '#/components/schemas/JobStatus' + required: + - job_id + - status + title: Job + type: object MetricInResponse: description: A metric value included in API responses. properties: @@ -8155,6 +4850,84 @@ components: - value title: MetricInResponse type: object + PaginatedResponse: + description: A generic paginated response that follows a simple format. + properties: + data: + items: + additionalProperties: true + type: object + title: Data + type: array + has_more: + title: Has More + type: boolean + url: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + - has_more + title: PaginatedResponse + type: object + PostTrainingMetric: + description: Training metrics captured during post-training jobs. + properties: + epoch: + title: Epoch + type: integer + train_loss: + title: Train Loss + type: number + validation_loss: + title: Validation Loss + type: number + perplexity: + title: Perplexity + type: number + required: + - epoch + - train_loss + - validation_loss + - perplexity + title: PostTrainingMetric + type: object + Checkpoint: + description: Checkpoint created during training runs. + properties: + identifier: + title: Identifier + type: string + created_at: + format: date-time + title: Created At + type: string + epoch: + title: Epoch + type: integer + post_training_job_id: + title: Post Training Job Id + type: string + path: + title: Path + type: string + training_metrics: + anyOf: + - $ref: '#/components/schemas/PostTrainingMetric' + title: PostTrainingMetric + - type: 'null' + nullable: true + title: PostTrainingMetric + required: + - identifier + - created_at + - epoch + - post_training_job_id + - path + title: Checkpoint + type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: @@ -8165,6 +4938,66 @@ components: type: string title: DialogType type: object + Conversation: + description: OpenAI-compatible conversation object. + properties: + id: + description: The unique ID of the conversation. + title: Id + type: string + object: + const: conversation + default: conversation + description: The object type, which is always conversation. + title: Object + type: string + created_at: + description: The time at which the conversation was created, measured in seconds since the Unix epoch. + title: Created At + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. + nullable: true + items: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + description: Initial items to include in the conversation context. You may add up to 20 items at a time. + nullable: true + required: + - id + - created_at + title: Conversation + type: object + ConversationDeletedResource: + description: Response for deleted conversation. + properties: + id: + description: The deleted conversation identifier + title: Id + type: string + object: + default: conversation.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationDeletedResource + type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: @@ -8210,6 +5043,93 @@ components: - items title: ConversationItemCreateRequest type: object + ConversationItemDeletedResource: + description: Response for deleted conversation item. + properties: + id: + description: The deleted item identifier + title: Id + type: string + object: + default: conversation.item.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationItemDeletedResource + type: object + ConversationItemList: + description: List of conversation items with pagination. + properties: + object: + default: list + description: Object type + title: Object + type: string + data: + description: List of conversation items + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the first item in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the last item in the list + nullable: true + has_more: + default: false + description: Whether there are more items available + title: Has More + type: boolean + required: + - data + title: ConversationItemList + type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: @@ -8249,6 +5169,857 @@ components: - status title: ConversationMessage type: object + DatasetPurpose: + description: Purpose of the dataset. Each purpose has a required input data schema. + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + type: string + Dataset: + description: Dataset resource for storing and accessing training or evaluation data. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: dataset + default: dataset + title: Type + type: string + purpose: + $ref: '#/components/schemas/DatasetPurpose' + source: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + metadata: + additionalProperties: true + description: Any additional metadata for this dataset + title: Metadata + type: object + required: + - identifier + - provider_id + - purpose + - source + title: Dataset + type: object + Error: + description: Error response from the API. Roughly follows RFC 7807. + properties: + status: + title: Status + type: integer + title: + title: Title + type: string + detail: + title: Detail + type: string + instance: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - status + - title + - detail + title: Error + type: object + Api: + description: Enumeration of all available APIs in the Llama Stack system. + enum: + - providers + - inference + - safety + - agents + - batches + - vector_io + - datasetio + - scoring + - eval + - post_training + - tool_runtime + - models + - shields + - vector_stores + - datasets + - scoring_functions + - benchmarks + - tool_groups + - files + - prompts + - conversations + - inspect + title: Api + type: string + InlineProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + container_image: + anyOf: + - type: string + - type: 'null' + description: |2 + + The container image to use for this implementation. If one is provided, pip_packages will be ignored. + If a provider depends on other providers, the dependencies MUST NOT specify a container image. + nullable: true + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + title: InlineProviderSpec + type: object + ModelType: + description: Enumeration of supported model types in Llama Stack. + enum: + - llm + - embedding + - rerank + title: ModelType + type: string + Model: + description: A model resource representing an AI model registered in Llama Stack. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: model + default: model + title: Type + type: string + metadata: + additionalProperties: true + description: Any additional metadata for this model + title: Metadata + type: object + model_type: + $ref: '#/components/schemas/ModelType' + default: llm + required: + - identifier + - provider_id + title: Model + type: object + ProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + required: + - api + - provider_type + - config_class + title: ProviderSpec + type: object + RemoteProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + adapter_type: + description: Unique identifier for this adapter + title: Adapter Type + type: string + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + - adapter_type + title: RemoteProviderSpec + type: object + ScoringFn: + description: A scoring function resource for evaluating model outputs. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: scoring_function + default: scoring_function + title: Type + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + description: Any additional metadata for this definition + title: Metadata + type: object + return_type: + description: The return type of the deterministic function + discriminator: + mapping: + array: '#/components/schemas/ArrayType' + boolean: '#/components/schemas/BooleanType' + chat_completion_input: '#/components/schemas/ChatCompletionInputType' + completion_input: '#/components/schemas/CompletionInputType' + json: '#/components/schemas/JsonType' + number: '#/components/schemas/NumberType' + object: '#/components/schemas/ObjectType' + string: '#/components/schemas/StringType' + union: '#/components/schemas/UnionType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/StringType' + title: StringType + - $ref: '#/components/schemas/NumberType' + title: NumberType + - $ref: '#/components/schemas/BooleanType' + title: BooleanType + - $ref: '#/components/schemas/ArrayType' + title: ArrayType + - $ref: '#/components/schemas/ObjectType' + title: ObjectType + - $ref: '#/components/schemas/JsonType' + title: JsonType + - $ref: '#/components/schemas/UnionType' + title: UnionType + - $ref: '#/components/schemas/ChatCompletionInputType' + title: ChatCompletionInputType + - $ref: '#/components/schemas/CompletionInputType' + title: CompletionInputType + title: StringType | ... (9 variants) + params: + anyOf: + - discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + title: Params + nullable: true + required: + - identifier + - provider_id + - return_type + title: ScoringFn + type: object + Shield: + description: A safety shield resource that can be used to check content. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: shield + default: shield + title: Type + type: string + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: Shield + type: object + ToolGroup: + description: A group of related tools managed together. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: tool_group + default: tool_group + title: Type + type: string + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: ToolGroup + type: object + ModelCandidate: + description: A model candidate for evaluation. + properties: + type: + const: model + default: model + title: Type + type: string + model: + title: Model + type: string + sampling_params: + $ref: '#/components/schemas/SamplingParams' + system_message: + anyOf: + - $ref: '#/components/schemas/SystemMessage' + title: SystemMessage + - type: 'null' + nullable: true + title: SystemMessage + required: + - model + - sampling_params + title: ModelCandidate + type: object + SamplingParams: + description: Sampling parameters. + properties: + strategy: + discriminator: + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreedySamplingStrategy' + title: GreedySamplingStrategy + - $ref: '#/components/schemas/TopPSamplingStrategy' + title: TopPSamplingStrategy + - $ref: '#/components/schemas/TopKSamplingStrategy' + title: TopKSamplingStrategy + title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + repetition_penalty: + anyOf: + - type: number + - type: 'null' + default: 1.0 + stop: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: SamplingParams + type: object + SystemMessage: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + title: string | list[ImageContentItem | TextContentItem] + required: + - content + title: SystemMessage + type: object + BenchmarkConfig: + description: A benchmark configuration for evaluation. + properties: + eval_candidate: + $ref: '#/components/schemas/ModelCandidate' + scoring_params: + additionalProperties: + discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + description: Map between scoring function id and parameters for each scoring function you want to run + title: Scoring Params + type: object + num_examples: + anyOf: + - type: integer + - type: 'null' + description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated + nullable: true + required: + - eval_candidate + title: BenchmarkConfig + type: object + ScoringResult: + description: A scoring result for a single row. + properties: + score_rows: + items: + additionalProperties: true + type: object + title: Score Rows + type: array + aggregated_results: + additionalProperties: true + title: Aggregated Results + type: object + required: + - score_rows + - aggregated_results + title: ScoringResult + type: object + EvaluateResponse: + description: The response from an evaluation. + properties: + generations: + items: + additionalProperties: true + type: object + title: Generations + type: array + scores: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Scores + type: object + required: + - generations + - scores + title: EvaluateResponse + type: object + ExpiresAfter: + description: |- + Control expiration of uploaded files. + + Params: + - anchor, must be "created_at" + - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) + properties: + anchor: + const: created_at + title: Anchor + type: string + seconds: + maximum: 2592000 + minimum: 3600 + title: Seconds + type: integer + required: + - anchor + - seconds + title: ExpiresAfter + type: object + OpenAIFileObject: + description: OpenAI File object as defined in the OpenAI Files API. + properties: + object: + const: file + default: file + title: Object + type: string + id: + title: Id + type: string + bytes: + title: Bytes + type: integer + created_at: + title: Created At + type: integer + expires_at: + title: Expires At + type: integer + filename: + title: Filename + type: string + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + required: + - id + - bytes + - created_at + - expires_at + - filename + - purpose + title: OpenAIFileObject + type: object + OpenAIFilePurpose: + description: Valid purpose values for OpenAI Files API. + enum: + - assistants + - batch + title: OpenAIFilePurpose + type: string + ListOpenAIFileResponse: + description: Response for listing files in OpenAI Files API. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIFileObject' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIFileResponse + type: object + OpenAIFileDeleteResponse: + description: Response for deleting a file in OpenAI Files API. + properties: + id: + title: Id + type: string + object: + const: file + default: file + title: Object + type: string + deleted: + title: Deleted + type: boolean + required: + - id + - deleted + title: OpenAIFileDeleteResponse + type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: @@ -8298,6 +6069,304 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig type: object + OpenAIChatCompletionUsage: + description: Usage information for OpenAI chat completion. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + completion_tokens: + title: Completion Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + prompt_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' + title: OpenAIChatCompletionUsagePromptTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + completion_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' + title: OpenAIChatCompletionUsageCompletionTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + required: + - prompt_tokens + - completion_tokens + - total_tokens + title: OpenAIChatCompletionUsage + type: object + OpenAIChatCompletionUsageCompletionTokensDetails: + description: Token details for output tokens in OpenAI chat completion usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + type: object + OpenAIChatCompletionUsagePromptTokensDetails: + description: Token details for prompt tokens in OpenAI chat completion usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + type: object + OpenAIChoice: + description: A choice from an OpenAI-compatible chat completion response. + properties: + message: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + finish_reason: + title: Finish Reason + type: string + index: + title: Index + type: integer + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + required: + - message + - finish_reason + - index + title: OpenAIChoice + type: object + OpenAIChoiceLogprobs: + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. + properties: + content: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + refusal: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + type: object + OpenAICompletionWithInputMessages: + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + input_messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + title: Input Messages + type: array + required: + - id + - choices + - created + - model + - input_messages + title: OpenAICompletionWithInputMessages + type: object + OpenAITokenLogProb: + description: |- + The log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + :top_logprobs: The top log probabilities for the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + title: Top Logprobs + type: array + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb + type: object + OpenAITopLogProb: + description: |- + The top log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + required: + - token + - logprob + title: OpenAITopLogProb + type: object + ListOpenAIChatCompletionResponse: + description: Response from listing OpenAI-compatible chat completions. + properties: + data: + items: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIChatCompletionResponse + type: object + OpenAIChatCompletion: + description: Response from an OpenAI-compatible chat completion request. + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + required: + - id + - choices + - created + - model + title: OpenAIChatCompletion + type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: @@ -8330,25 +6399,6 @@ components: nullable: true title: OpenAIChoiceDelta type: object - OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - title: OpenAIChoiceLogprobs - type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: @@ -8409,48 +6459,181 @@ components: - model title: OpenAIChatCompletionChunk type: object - OpenAIChoice: - description: A choice from an OpenAI-compatible chat completion response. + OpenAIChatCompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible chat completion endpoint. properties: - message: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - finish_reason: - title: Finish Reason + model: + title: Model type: string - index: - title: Index - type: integer - logprobs: + messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + minItems: 1 + title: Messages + type: array + frequency_penalty: anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs' - title: OpenAIChoiceLogprobs + - type: number + - type: 'null' + nullable: true + function_call: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + functions: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_completion_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + response_format: + anyOf: + - discriminator: + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseFormatText' + title: OpenAIResponseFormatText + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + title: OpenAIResponseFormatJSONSchema + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + title: OpenAIResponseFormatJSONObject + title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + - type: 'null' + title: Response Format + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + tool_choice: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + tools: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + top_logprobs: + anyOf: + - type: integer + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string - type: 'null' nullable: true - title: OpenAIChoiceLogprobs required: - - message - - finish_reason - - index - title: OpenAIChoice + - model + - messages + title: OpenAIChatCompletionRequestWithExtraBody type: object OpenAICompletionChoice: description: |- @@ -8483,6 +6666,42 @@ components: - index title: OpenAICompletionChoice type: object + OpenAICompletion: + description: |- + Response from an OpenAI-compatible completion request. + + :id: The ID of the completion + :choices: List of choices + :created: The Unix timestamp in seconds when the completion was created + :model: The model that was used to generate the completion + :object: The object type, which will be "text_completion" + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + title: Choices + type: array + created: + title: Created + type: integer + model: + title: Model + type: string + object: + const: text_completion + default: text_completion + title: Object + type: string + required: + - id + - choices + - created + - model + title: OpenAICompletion + type: object OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -8524,6 +6743,247 @@ components: nullable: true title: OpenAICompletionLogprobs type: object + OpenAICompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible completion endpoint. + properties: + model: + title: Model + type: string + prompt: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - items: + type: integer + type: array + title: list[integer] + - items: + items: + type: integer + type: array + type: array + title: list[array] + title: string | ... (4 variants) + best_of: + anyOf: + - type: integer + - type: 'null' + nullable: true + echo: + anyOf: + - type: boolean + - type: 'null' + nullable: true + frequency_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + suffix: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - prompt + title: OpenAICompletionRequestWithExtraBody + type: object + OpenAIEmbeddingData: + description: A single embedding data object from an OpenAI-compatible embeddings response. + properties: + object: + const: embedding + default: embedding + title: Object + type: string + embedding: + anyOf: + - items: + type: number + type: array + title: list[number] + - type: string + title: list[number] | string + index: + title: Index + type: integer + required: + - embedding + - index + title: OpenAIEmbeddingData + type: object + OpenAIEmbeddingUsage: + description: Usage information for an OpenAI-compatible embeddings response. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + required: + - prompt_tokens + - total_tokens + title: OpenAIEmbeddingUsage + type: object + OpenAIEmbeddingsRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible embeddings endpoint. + properties: + model: + title: Model + type: string + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + encoding_format: + anyOf: + - type: string + - type: 'null' + default: float + dimensions: + anyOf: + - type: integer + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - input + title: OpenAIEmbeddingsRequestWithExtraBody + type: object + OpenAIEmbeddingsResponse: + description: Response from an OpenAI-compatible embeddings request. + properties: + object: + const: list + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/OpenAIEmbeddingData' + title: Data + type: array + model: + title: Model + type: string + usage: + $ref: '#/components/schemas/OpenAIEmbeddingUsage' + required: + - data + - model + - usage + title: OpenAIEmbeddingsResponse + type: object + RerankData: + description: A single rerank result from a reranking response. + properties: + index: + title: Index + type: integer + relevance_score: + title: Relevance Score + type: number + required: + - index + - relevance_score + title: RerankData + type: object + RerankResponse: + description: Response from a reranking request. + properties: + data: + items: + $ref: '#/components/schemas/RerankData' + title: Data + type: array + required: + - data + title: RerankResponse + type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: @@ -8653,6 +7113,233 @@ components: - content title: UserMessage type: object + HealthStatus: + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + type: string + HealthInfo: + description: Health status information for the service. + properties: + status: + $ref: '#/components/schemas/HealthStatus' + required: + - status + title: HealthInfo + type: object + RouteInfo: + description: Information about an API route including its path, method, and implementing providers. + properties: + route: + title: Route + type: string + method: + title: Method + type: string + provider_types: + items: + type: string + title: Provider Types + type: array + required: + - route + - method + - provider_types + title: RouteInfo + type: object + ListRoutesResponse: + description: Response containing a list of all available API routes. + properties: + data: + items: + $ref: '#/components/schemas/RouteInfo' + title: Data + type: array + required: + - data + title: ListRoutesResponse + type: object + VersionInfo: + description: Version information for the service. + properties: + version: + title: Version + type: string + required: + - version + title: VersionInfo + type: object + OpenAIModel: + description: |- + A model from OpenAI. + + :id: The ID of the model + :object: The object type, which will be "model" + :created: The Unix timestamp in seconds when the model was created + :owned_by: The owner of the model + :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata + properties: + id: + title: Id + type: string + object: + const: model + default: model + title: Object + type: string + created: + title: Created + type: integer + owned_by: + title: Owned By + type: string + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - id + - created + - owned_by + title: OpenAIModel + type: object + DPOLossType: + enum: + - sigmoid + - hinge + - ipo + - kto_pair + title: DPOLossType + type: string + DPOAlignmentConfig: + description: Configuration for Direct Preference Optimization (DPO) alignment. + properties: + beta: + title: Beta + type: number + loss_type: + $ref: '#/components/schemas/DPOLossType' + default: sigmoid + required: + - beta + title: DPOAlignmentConfig + type: object + DatasetFormat: + description: Format of the training dataset. + enum: + - instruct + - dialog + title: DatasetFormat + type: string + DataConfig: + description: Configuration for training data and data loading. + properties: + dataset_id: + title: Dataset Id + type: string + batch_size: + title: Batch Size + type: integer + shuffle: + title: Shuffle + type: boolean + data_format: + $ref: '#/components/schemas/DatasetFormat' + validation_dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + packed: + anyOf: + - type: boolean + - type: 'null' + default: false + train_on_input: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - dataset_id + - batch_size + - shuffle + - data_format + title: DataConfig + type: object + EfficiencyConfig: + description: Configuration for memory and compute efficiency optimizations. + properties: + enable_activation_checkpointing: + anyOf: + - type: boolean + - type: 'null' + default: false + enable_activation_offloading: + anyOf: + - type: boolean + - type: 'null' + default: false + memory_efficient_fsdp_wrap: + anyOf: + - type: boolean + - type: 'null' + default: false + fsdp_cpu_offload: + anyOf: + - type: boolean + - type: 'null' + default: false + title: EfficiencyConfig + type: object + OptimizerType: + description: Available optimizer algorithms for training. + enum: + - adam + - adamw + - sgd + title: OptimizerType + type: string + OptimizerConfig: + description: Configuration parameters for the optimization algorithm. + properties: + optimizer_type: + $ref: '#/components/schemas/OptimizerType' + lr: + title: Lr + type: number + weight_decay: + title: Weight Decay + type: number + num_warmup_steps: + title: Num Warmup Steps + type: integer + required: + - optimizer_type + - lr + - weight_decay + - num_warmup_steps + title: OptimizerConfig + type: object + PostTrainingJobArtifactsResponse: + description: Artifacts of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + title: PostTrainingJobArtifactsResponse + type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -8669,12 +7356,103 @@ components: - log_lines title: PostTrainingJobLogStream type: object + PostTrainingJobStatusResponse: + description: Status of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + status: + $ref: '#/components/schemas/JobStatus' + scheduled_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + started_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + completed_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + resources_allocated: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + - status + title: PostTrainingJobStatusResponse + type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string + TrainingConfig: + description: Comprehensive configuration for the training process. + properties: + n_epochs: + title: N Epochs + type: integer + max_steps_per_epoch: + default: 1 + title: Max Steps Per Epoch + type: integer + gradient_accumulation_steps: + default: 1 + title: Gradient Accumulation Steps + type: integer + max_validation_steps: + anyOf: + - type: integer + - type: 'null' + default: 1 + data_config: + anyOf: + - $ref: '#/components/schemas/DataConfig' + title: DataConfig + - type: 'null' + nullable: true + title: DataConfig + optimizer_config: + anyOf: + - $ref: '#/components/schemas/OptimizerConfig' + title: OptimizerConfig + - type: 'null' + nullable: true + title: OptimizerConfig + efficiency_config: + anyOf: + - $ref: '#/components/schemas/EfficiencyConfig' + title: EfficiencyConfig + - type: 'null' + nullable: true + title: EfficiencyConfig + dtype: + anyOf: + - type: string + - type: 'null' + default: bf16 + required: + - n_epochs + title: TrainingConfig + type: object PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: @@ -8718,6 +7496,247 @@ components: - logger_config title: PostTrainingRLHFRequest type: object + Prompt: + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. + properties: + prompt: + anyOf: + - type: string + - type: 'null' + description: The system prompt with variable placeholders + nullable: true + version: + description: Version (integer starting at 1, incremented on save) + minimum: 1 + title: Version + type: integer + prompt_id: + description: Unique identifier in format 'pmpt_<48-digit-hash>' + title: Prompt Id + type: string + variables: + description: List of variable names that can be used in the prompt template + items: + type: string + title: Variables + type: array + is_default: + default: false + description: Boolean indicating whether this version is the default version + title: Is Default + type: boolean + required: + - version + - prompt_id + title: Prompt + type: object + ProviderInfo: + description: Information about a registered provider including its configuration and health status. + properties: + api: + title: Api + type: string + provider_id: + title: Provider Id + type: string + provider_type: + title: Provider Type + type: string + config: + additionalProperties: true + title: Config + type: object + health: + additionalProperties: true + title: Health + type: object + required: + - api + - provider_id + - provider_type + - config + - health + title: ProviderInfo + type: object + ModerationObjectResults: + description: A moderation object. + properties: + flagged: + title: Flagged + type: boolean + categories: + anyOf: + - additionalProperties: + type: boolean + type: object + - type: 'null' + nullable: true + category_applied_input_types: + anyOf: + - additionalProperties: + items: + type: string + type: array + type: object + - type: 'null' + nullable: true + category_scores: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - flagged + title: ModerationObjectResults + type: object + ModerationObject: + description: A moderation object. + properties: + id: + title: Id + type: string + model: + title: Model + type: string + results: + items: + $ref: '#/components/schemas/ModerationObjectResults' + title: Results + type: array + required: + - id + - model + - results + title: ModerationObject + type: object + SafetyViolation: + description: Details of a safety violation detected by content moderation. + properties: + violation_level: + $ref: '#/components/schemas/ViolationLevel' + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - violation_level + title: SafetyViolation + type: object + ViolationLevel: + description: Severity level of a safety violation. + enum: + - info + - warn + - error + title: ViolationLevel + type: string + RunShieldResponse: + description: Response from running a safety shield. + properties: + violation: + anyOf: + - $ref: '#/components/schemas/SafetyViolation' + title: SafetyViolation + - type: 'null' + nullable: true + title: SafetyViolation + title: RunShieldResponse + type: object + ScoreBatchResponse: + description: Response from batch scoring operations on datasets. + properties: + dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreBatchResponse + type: object + ScoreResponse: + description: The response from scoring. + properties: + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreResponse + type: object + ToolDef: + description: Tool definition used in runtime contexts. + properties: + toolgroup_id: + anyOf: + - type: string + - type: 'null' + nullable: true + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + input_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + output_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - name + title: ToolDef + type: object + ListToolDefsResponse: + description: Response containing a list of tool definitions. + properties: + data: + items: + $ref: '#/components/schemas/ToolDef' + title: Data + type: array + required: + - data + title: ListToolDefsResponse + type: object ToolGroupInput: description: Input data for registering a tool group. properties: @@ -8745,6 +7764,122 @@ components: - provider_id title: ToolGroupInput type: object + ToolInvocationResult: + description: Result of a tool invocation. + properties: + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + - type: 'null' + title: string | list[ImageContentItem | TextContentItem] + nullable: true + error_message: + anyOf: + - type: string + - type: 'null' + nullable: true + error_code: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: ToolInvocationResult + type: object + ChunkMetadata: + description: |- + `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that + will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` + is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. + Use `Chunk.metadata` for metadata that will be used in the context during inference. + properties: + chunk_id: + anyOf: + - type: string + - type: 'null' + nullable: true + document_id: + anyOf: + - type: string + - type: 'null' + nullable: true + source: + anyOf: + - type: string + - type: 'null' + nullable: true + created_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + updated_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + chunk_window: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_tokenizer: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_model: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_dimension: + anyOf: + - type: integer + - type: 'null' + nullable: true + content_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: ChunkMetadata + type: object Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -8803,6 +7938,140 @@ components: - chunk_id title: Chunk type: object + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store file batch with extra_body support. + properties: + file_ids: + items: + type: string + title: File Ids + type: array + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + required: + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + type: object + OpenAICreateVectorStoreRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store with extra_body support. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + file_ids: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: OpenAICreateVectorStoreRequestWithExtraBody + type: object + QueryChunksResponse: + description: Response from querying chunks in a vector database. + properties: + chunks: + items: + $ref: '#/components/schemas/Chunk' + title: Chunks + type: array + scores: + items: + type: number + title: Scores + type: array + required: + - chunks + - scores + title: QueryChunksResponse + type: object + VectorStoreContent: + description: Content item from a vector store file or search result. + properties: + type: + const: text + title: Type + type: string + text: + title: Text + type: string + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + nullable: true + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + nullable: true + title: ChunkMetadata + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - type + - text + title: VectorStoreContent + type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: @@ -8834,6 +8103,351 @@ components: type: object title: VectorStoreCreateRequest type: object + VectorStoreDeleteResponse: + description: Response from deleting a vector store. + properties: + id: + title: Id + type: string + object: + default: vector_store.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreDeleteResponse + type: object + VectorStoreFileCounts: + description: File processing status counts for a vector store. + properties: + completed: + title: Completed + type: integer + cancelled: + title: Cancelled + type: integer + failed: + title: Failed + type: integer + in_progress: + title: In Progress + type: integer + total: + title: Total + type: integer + required: + - completed + - cancelled + - failed + - in_progress + - total + title: VectorStoreFileCounts + type: object + VectorStoreFileBatchObject: + description: OpenAI Vector Store File Batch object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file_batch + title: Object + type: string + created_at: + title: Created At + type: integer + vector_store_id: + title: Vector Store Id + type: string + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + required: + - id + - created_at + - vector_store_id + - status + - file_counts + title: VectorStoreFileBatchObject + type: object + VectorStoreFileContentResponse: + description: Represents the parsed content of a vector store file. + properties: + object: + const: vector_store.file_content.page + default: vector_store.file_content.page + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreContent' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + title: VectorStoreFileContentResponse + type: object + VectorStoreFileDeleteResponse: + description: Response from deleting a vector store file. + properties: + id: + title: Id + type: string + object: + default: vector_store.file.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreFileDeleteResponse + type: object + VectorStoreFileLastError: + description: Error information for failed vector store file processing. + properties: + code: + title: Code + type: string + enum: + - server_error + - rate_limit_exceeded + default: server_error + message: + title: Message + type: string + required: + - code + - message + title: VectorStoreFileLastError + type: object + VectorStoreFileObject: + description: OpenAI Vector Store File object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file + title: Object + type: string + attributes: + additionalProperties: true + title: Attributes + type: object + chunking_strategy: + discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + created_at: + title: Created At + type: integer + last_error: + anyOf: + - $ref: '#/components/schemas/VectorStoreFileLastError' + title: VectorStoreFileLastError + - type: 'null' + nullable: true + title: VectorStoreFileLastError + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + vector_store_id: + title: Vector Store Id + type: string + required: + - id + - chunking_strategy + - created_at + - status + - vector_store_id + title: VectorStoreFileObject + type: object + VectorStoreFilesListInBatchResponse: + description: Response from listing files in a vector store file batch. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreFilesListInBatchResponse + type: object + VectorStoreListFilesResponse: + description: Response from listing files in a vector store. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListFilesResponse + type: object + VectorStoreObject: + description: OpenAI Vector Store object. + properties: + id: + title: Id + type: string + object: + default: vector_store + title: Object + type: string + created_at: + title: Created At + type: integer + name: + anyOf: + - type: string + - type: 'null' + nullable: true + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + status: + default: completed + title: Status + type: string + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + last_active_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - id + - created_at + - file_counts + title: VectorStoreObject + type: object + VectorStoreListResponse: + description: Response from listing vector stores. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListResponse + type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: @@ -8926,75 +8540,34 @@ components: - content title: VectorStoreSearchResponse type: object - OpenAIResponseMessageOutputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageOutputOneOf - title: OpenAIResponseMessage-Output | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageOutputUnion - responses: - BadRequest400: - description: The request was invalid or malformed - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 400 - title: Bad Request - detail: The request was invalid or malformed - TooManyRequests429: - description: The client has sent too many requests in a given amount of time - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 429 - title: Too Many Requests - detail: You have exceeded the rate limit. Please try again later. - InternalServerError500: - description: The server encountered an unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 500 - title: Internal Server Error - detail: An unexpected error occurred - DefaultError: - description: An error occurred - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + VectorStoreSearchResponsePage: + description: Paginated response from searching a vector store. + properties: + object: + default: vector_store.search_results.page + title: Object + type: string + search_query: + items: + type: string + title: Search Query + type: array + data: + items: + $ref: '#/components/schemas/VectorStoreSearchResponse' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - search_query + - data + title: VectorStoreSearchResponsePage + type: object diff --git a/docs/static/llama-stack-spec.yaml b/docs/static/llama-stack-spec.yaml index 1dad5b55f..032c4bcaf 100644 --- a/docs/static/llama-stack-spec.yaml +++ b/docs/static/llama-stack-spec.yaml @@ -17,18 +17,13 @@ paths: tags: - Providers summary: Inspect Provider - description: |- - Get provider. - - Get detailed information about a specific provider. operationId: inspect_provider_v1_providers__provider_id__get responses: '200': - description: A ProviderInfo object containing the provider's details. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ProviderInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -53,18 +48,13 @@ paths: tags: - Providers summary: List Providers - description: |- - List providers. - - List all available providers. operationId: list_providers_v1_providers_get responses: '200': - description: A ListProvidersResponse containing information about all providers. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListProvidersResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -82,134 +72,60 @@ paths: tags: - Agents summary: List Openai Responses - description: List all responses. operationId: list_openai_responses_v1_responses_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 50 - title: Limit - - name: model - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Model - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order responses: '200': - description: A ListOpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIResponseObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Agents summary: Create Openai Response - description: Create a model response. operationId: create_openai_response_v1_responses_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_responses_Request' - x-llama-stack-extra-body-params: - guardrails: - $defs: - ResponseGuardrailSpec: - description: |- - Specification for a guardrail to apply during response generation. - - :param type: The type/identifier of the guardrail. - properties: - type: - title: Type - type: string - required: - - type - title: ResponseGuardrailSpec - type: object - anyOf: - - items: - anyOf: - - type: string - - $ref: '#/components/schemas/ResponseGuardrailSpec' - type: array - - type: 'null' - description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation. responses: '200': - description: An OpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseObject' - text/event-stream: - schema: - $ref: '#/components/schemas/OpenAIResponseObjectStream' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/responses/{response_id}: get: tags: - Agents summary: Get Openai Response - description: Get a model response. operationId: get_openai_response_v1_responses__response_id__get responses: '200': - description: An OpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -233,15 +149,13 @@ paths: tags: - Agents summary: Delete Openai Response - description: Delete a response. operationId: delete_openai_response_v1_responses__response_id__delete responses: '200': - description: An OpenAIDeleteResponseObject + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIDeleteResponseObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -266,95 +180,44 @@ paths: tags: - Agents summary: List Openai Response Input Items - description: List input items. operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' - - name: include - in: query - required: false - schema: - anyOf: - - type: array - items: - type: string - - type: 'null' - title: Include - responses: - '200': - description: An ListOpenAIResponseInputItem. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIResponseInputItem' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/chat/completions/{completion_id}: get: tags: - Inference summary: Get Chat Completion - description: |- - Get chat completion. - - Describe a chat completion by its ID. operationId: get_chat_completion_v1_chat_completions__completion_id__get responses: '200': - description: A OpenAICompletionWithInputMessages. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -379,122 +242,60 @@ paths: tags: - Inference summary: List Chat Completions - description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: model - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Model - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order responses: '200': - description: A ListOpenAIChatCompletionResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Inference summary: Openai Chat Completion - description: |- - Create chat completions. - - Generate an OpenAI-compatible chat completion for the given messages using the specified model. operationId: openai_chat_completion_v1_chat_completions_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' responses: '200': - description: An OpenAIChatCompletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIChatCompletion' - text/event-stream: - schema: - $ref: '#/components/schemas/OpenAIChatCompletionChunk' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/completions: post: tags: - Inference summary: Openai Completion - description: |- - Create completion. - - Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' - required: true responses: '200': - description: An OpenAICompletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAICompletion' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -512,24 +313,13 @@ paths: tags: - Inference summary: Openai Embeddings - description: |- - Create embeddings. - - Generate OpenAI-compatible embeddings for the given input using the specified model. operationId: openai_embeddings_v1_embeddings_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' - required: true responses: '200': - description: An OpenAIEmbeddingsResponse containing the embeddings. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -547,18 +337,13 @@ paths: tags: - Inspect summary: Health - description: |- - Get health status. - - Get the current health status of the service. operationId: health_v1_health_get responses: '200': - description: Health information indicating if the service is operational. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/HealthInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -576,61 +361,37 @@ paths: tags: - Inspect summary: List Routes - description: |- - List routes. - - List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get - parameters: - - name: api_filter - in: query - required: false - schema: - anyOf: - - enum: - - v1 - - v1alpha - - v1beta - - deprecated - type: string - - type: 'null' - title: Api Filter responses: '200': - description: Response containing information about all available routes. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListRoutesResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/version: get: tags: - Inspect summary: Version - description: |- - Get version. - - Get the version of the service. operationId: version_v1_version_get responses: '200': - description: Version information containing the service version number. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VersionInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -648,15 +409,13 @@ paths: tags: - Batches summary: Cancel Batch - description: Cancel a batch that is in progress. operationId: cancel_batch_v1_batches__batch_id__cancel_post responses: '200': - description: The updated batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -681,88 +440,60 @@ paths: tags: - Batches summary: List Batches - description: List all batches for the current user. operationId: list_batches_v1_batches_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - type: integer - default: 20 - title: Limit responses: '200': - description: A list of batch objects. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListBatchesResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Batches summary: Create Batch - description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_batches_Request' responses: '200': - description: The created batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/batches/{batch_id}: get: tags: - Batches summary: Retrieve Batch - description: Retrieve information about a specific batch. operationId: retrieve_batch_v1_batches__batch_id__get responses: '200': - description: The batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -787,17 +518,7 @@ paths: tags: - Vector Io summary: Insert Chunks - description: Insert chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Chunk-Input' - title: Chunks responses: '200': description: Successful Response @@ -805,128 +526,71 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/files: get: tags: - Vector Io summary: Openai List Files In Vector Store - description: List files in a vector store. operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: filter - in: query - required: false - schema: - title: Filter - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - nullable: true - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - responses: - '200': - description: A VectorStoreListFilesResponse containing the list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreListFilesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Vector Io summary: Openai Attach File To Vector Store - description: Attach a file to a vector store. operationId: openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_files_Request' responses: '200': - description: A VectorStoreFileObject representing the attached file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path @@ -939,15 +603,13 @@ paths: tags: - Vector Io summary: Openai Cancel Vector Store File Batch - description: Cancels a vector store file batch. operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post responses: '200': - description: A VectorStoreFileBatchObject representing the cancelled file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -978,119 +640,60 @@ paths: tags: - Vector Io summary: Openai List Vector Stores - description: Returns a list of vector stores. operationId: openai_list_vector_stores_v1_vector_stores_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order responses: '200': - description: A VectorStoreListResponse containing the list of vector stores. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreListResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Vector Io summary: Openai Create Vector Store - description: |- - Creates a vector store. - - Generate an OpenAI-compatible vector store with the given parameters. operationId: openai_create_vector_store_v1_vector_stores_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' responses: '200': - description: A VectorStoreObject representing the created vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/file_batches: post: tags: - Vector Io summary: Openai Create Vector Store File Batch - description: |- - Create a vector store file batch. - - Generate an OpenAI-compatible vector store file batch for the given vector store. operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' - required: true responses: '200': - description: A VectorStoreFileBatchObject representing the created file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1115,15 +718,13 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store - description: Retrieves a vector store. operationId: openai_retrieve_vector_store_v1_vector_stores__vector_store_id__get responses: '200': - description: A VectorStoreObject representing the vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1147,21 +748,13 @@ paths: tags: - Vector Io summary: Openai Update Vector Store - description: Updates a vector store. operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_Request' - required: true responses: '200': - description: A VectorStoreObject representing the updated vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1185,15 +778,13 @@ paths: tags: - Vector Io summary: Openai Delete Vector Store - description: Delete a vector store. operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete responses: '200': - description: A VectorStoreDeleteResponse indicating the deletion status. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1218,15 +809,13 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store File - description: Retrieves a vector store file. operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get responses: '200': - description: A VectorStoreFileObject representing the file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1256,21 +845,13 @@ paths: tags: - Vector Io summary: Openai Update Vector Store File - description: Updates a vector store file. operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_files_file_id_Request' - required: true responses: '200': - description: A VectorStoreFileObject representing the updated file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1300,15 +881,13 @@ paths: tags: - Vector Io summary: Openai Delete Vector Store File - description: Delete a vector store file. operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete responses: '200': - description: A VectorStoreFileDeleteResponse indicating the deletion status. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1339,51 +918,26 @@ paths: tags: - Vector Io summary: Openai List Files In Vector Store File Batch - description: Returns a list of vector store files in a batch. operationId: openai_list_files_in_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: filter - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Filter - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order - name: vector_store_id in: path required: true @@ -1396,39 +950,18 @@ paths: schema: type: string description: 'Path parameter: batch_id' - responses: - '200': - description: A VectorStoreFilesListInBatchResponse containing the list of files in the batch. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}: get: tags: - Vector Io summary: Openai Retrieve Vector Store File Batch - description: Retrieve a vector store file batch. operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get responses: '200': - description: A VectorStoreFileBatchObject representing the file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1459,27 +992,26 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store File Contents - description: Retrieves the contents of a vector store file. operationId: openai_retrieve_vector_store_file_contents_v1_vector_stores__vector_store_id__files__file_id__content_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: include_embeddings - in: query - required: false - schema: - anyOf: - - type: boolean - - type: 'null' - default: false - title: Include Embeddings - - name: include_metadata - in: query - required: false - schema: - anyOf: - - type: boolean - - type: 'null' - default: false - title: Include Metadata - name: vector_store_id in: path required: true @@ -1492,48 +1024,18 @@ paths: schema: type: string description: 'Path parameter: file_id' - responses: - '200': - description: File contents, optionally with embeddings and metadata based on query parameters. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileContentResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/vector_stores/{vector_store_id}/search: post: tags: - Vector Io summary: Openai Search Vector Store - description: |- - Search for chunks in a vector store. - - Searches a vector store for relevant chunks based on a query and optional file attribute filters. operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_search_Request' - required: true responses: '200': - description: A VectorStoreSearchResponse containing the search results. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreSearchResponsePage' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1558,21 +1060,13 @@ paths: tags: - Vector Io summary: Query Chunks - description: Query chunks from a vector database. operationId: query_chunks_v1_vector_io_query_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_io_query_Request' - required: true responses: '200': - description: A QueryChunksResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/QueryChunksResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1590,18 +1084,13 @@ paths: tags: - Models summary: Get Model - description: |- - Get model. - - Get a model by its identifier. operationId: get_model_v1_models__model_id__get responses: '200': - description: A Model. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Model' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1626,15 +1115,13 @@ paths: tags: - Models summary: Openai List Models - description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get responses: '200': - description: A OpenAIListModelsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIListModelsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1652,24 +1139,13 @@ paths: tags: - Safety summary: Run Moderation - description: |- - Create moderation. - - Classifies if text and/or image inputs are potentially harmful. operationId: run_moderation_v1_moderations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_moderations_Request' - required: true responses: '200': - description: A moderation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ModerationObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1687,24 +1163,13 @@ paths: tags: - Safety summary: Run Shield - description: |- - Run shield. - - Run a shield. operationId: run_shield_v1_safety_run_shield_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_safety_run_shield_Request' - required: true responses: '200': - description: A RunShieldResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/RunShieldResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1722,15 +1187,13 @@ paths: tags: - Shields summary: Get Shield - description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1755,15 +1218,13 @@ paths: tags: - Shields summary: List Shields - description: List all shields. operationId: list_shields_v1_shields_get responses: '200': - description: A ListShieldsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListShieldsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1781,21 +1242,13 @@ paths: tags: - Scoring summary: Score - description: Score a list of rows. operationId: score_v1_scoring_score_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_scoring_score_Request' - required: true responses: '200': - description: A ScoreResponse object containing rows and aggregated results. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoreResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1813,21 +1266,13 @@ paths: tags: - Scoring summary: Score Batch - description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_scoring_score_batch_Request' - required: true responses: '200': - description: A ScoreBatchResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoreBatchResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1845,15 +1290,13 @@ paths: tags: - Scoring Functions summary: Get Scoring Function - description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get responses: '200': - description: A ScoringFn. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoringFn' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1878,41 +1321,37 @@ paths: tags: - Scoring Functions summary: List Scoring Functions - description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get responses: '200': - description: A ListScoringFunctionsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListScoringFunctionsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tools/{tool_name}: get: tags: - Tool Groups summary: Get Tool - description: Get a tool by its name. operationId: get_tool_v1_tools__tool_name__get responses: '200': - description: A ToolDef. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolDef' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1937,15 +1376,13 @@ paths: tags: - Tool Groups summary: Get Tool Group - description: Get a tool group by its ID. operationId: get_tool_group_v1_toolgroups__toolgroup_id__get responses: '200': - description: A ToolGroup. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolGroup' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1970,82 +1407,61 @@ paths: tags: - Tool Groups summary: List Tool Groups - description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get responses: '200': - description: A ListToolGroupsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolGroupsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tools: get: tags: - Tool Groups summary: List Tools - description: List tools with optional tool group. operationId: list_tools_v1_tools_get - parameters: - - name: toolgroup_id - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Toolgroup Id responses: '200': - description: A ListToolDefsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolDefsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tool-runtime/invoke: post: tags: - Tool Runtime summary: Invoke Tool - description: Run a tool with the given arguments. operationId: invoke_tool_v1_tool_runtime_invoke_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_tool_runtime_invoke_Request' - required: true responses: '200': - description: A ToolInvocationResult. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolInvocationResult' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2063,61 +1479,37 @@ paths: tags: - Tool Runtime summary: List Runtime Tools - description: List all tools in the runtime. operationId: list_runtime_tools_v1_tool_runtime_list_tools_get - parameters: - - name: tool_group_id - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Tool Group Id - - name: mcp_endpoint - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/URL' - - type: 'null' - title: Mcp Endpoint responses: '200': - description: A ListToolDefsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolDefsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/files/{file_id}: get: tags: - Files summary: Openai Retrieve File - description: |- - Retrieve file. - - Returns information about a specific file. operationId: openai_retrieve_file_v1_files__file_id__get responses: '200': - description: An OpenAIFileObject containing file information. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2141,15 +1533,13 @@ paths: tags: - Files summary: Openai Delete File - description: Delete file. operationId: openai_delete_file_v1_files__file_id__delete responses: '200': - description: An OpenAIFileDeleteResponse indicating successful deletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2174,117 +1564,57 @@ paths: tags: - Files summary: Openai List Files - description: |- - List files. - - Returns a list of files that belong to the user's organization. operationId: openai_list_files_v1_files_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 10000 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order - - name: purpose - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/OpenAIFilePurpose' - - type: 'null' - title: Purpose responses: '200': - description: An ListOpenAIFileResponse containing the list of files. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIFileResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Files summary: Openai Upload File - description: |- - Upload file. - - Upload a file that can be used across various endpoints. - - The file upload should be a multipart form request with: - - file: The File object (not file name) to be uploaded. - - purpose: The intended purpose of the uploaded file. - - expires_after: Optional form values describing expiration for the file. operationId: openai_upload_file_v1_files_post - requestBody: - required: true - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/Body_openai_upload_file_v1_files_post' responses: '200': - description: An OpenAIFileObject representing the uploaded file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/files/{file_id}/content: get: tags: - Files summary: Openai Retrieve File Content - description: |- - Retrieve file content. - - Returns the contents of the specified file. operationId: openai_retrieve_file_content_v1_files__file_id__content_get responses: '200': - description: The raw file content as a binary response. + description: Successful Response content: application/json: schema: {} @@ -2312,15 +1642,13 @@ paths: tags: - Prompts summary: List Prompts - description: List all prompts. operationId: list_prompts_v1_prompts_get responses: '200': - description: A ListPromptsResponse containing all prompts. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2337,24 +1665,13 @@ paths: tags: - Prompts summary: Create Prompt - description: |- - Create prompt. - - Create a new prompt. operationId: create_prompt_v1_prompts_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_Request' - required: true responses: '200': - description: The created Prompt resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2372,79 +1689,55 @@ paths: tags: - Prompts summary: Get Prompt - description: |- - Get prompt. - - Get a prompt by its identifier and optional version. operationId: get_prompt_v1_prompts__prompt_id__get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: version - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Version - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' - responses: - '200': - description: A Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Prompts summary: Update Prompt - description: |- - Update prompt. - - Update an existing prompt (increments version). operationId: update_prompt_v1_prompts__prompt_id__post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_prompt_id_Request' responses: '200': - description: The updated Prompt resource with incremented version. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path @@ -2456,10 +1749,6 @@ paths: tags: - Prompts summary: Delete Prompt - description: |- - Delete prompt. - - Delete a prompt. operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': @@ -2468,17 +1757,17 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path @@ -2491,18 +1780,13 @@ paths: tags: - Prompts summary: List Prompt Versions - description: |- - List prompt versions. - - List all versions of a specific prompt. operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get responses: '200': - description: A ListPromptsResponse containing all versions of the prompt. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2527,24 +1811,13 @@ paths: tags: - Prompts summary: Set Default Version - description: |- - Set prompt version. - - Set which version of a prompt should be the default in get_prompt (latest). operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_prompt_id_set_default_version_Request' - required: true responses: '200': - description: The prompt with the specified version now set as default. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2569,108 +1842,55 @@ paths: tags: - Conversations summary: List Items - description: |- - List items. - - List items in the conversation. operationId: list_items_v1_conversations__conversation_id__items_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - enum: - - asc - - desc - type: string - - type: 'null' - title: Order - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' - - name: include - in: query - required: false - schema: - anyOf: - - type: array - items: - $ref: '#/components/schemas/ConversationItemInclude' - - type: 'null' - title: Include - responses: - '200': - description: List of conversation items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Conversations summary: Add Items - description: |- - Create items. - - Create items in the conversation. operationId: add_items_v1_conversations__conversation_id__items_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_conversation_id_items_Request' responses: '200': - description: List of created items. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path @@ -2683,24 +1903,13 @@ paths: tags: - Conversations summary: Create Conversation - description: |- - Create a conversation. - - Create a conversation. operationId: create_conversation_v1_conversations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_Request' - required: true responses: '200': - description: The created conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2718,18 +1927,13 @@ paths: tags: - Conversations summary: Get Conversation - description: |- - Retrieve a conversation. - - Get a conversation with the given ID. operationId: get_conversation_v1_conversations__conversation_id__get responses: '200': - description: The conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2753,24 +1957,13 @@ paths: tags: - Conversations summary: Update Conversation - description: |- - Update a conversation. - - Update a conversation's metadata with the given ID. operationId: update_conversation_v1_conversations__conversation_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_conversation_id_Request' - required: true responses: '200': - description: The updated conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2794,18 +1987,13 @@ paths: tags: - Conversations summary: Openai Delete Conversation - description: |- - Delete a conversation. - - Delete a conversation with the given ID. operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': - description: The deleted conversation resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationDeletedResource' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2830,18 +2018,13 @@ paths: tags: - Conversations summary: Retrieve - description: |- - Retrieve an item. - - Retrieve a conversation item. operationId: retrieve_v1_conversations__conversation_id__items__item_id__get responses: '200': - description: The conversation item. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseMessage' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2871,18 +2054,13 @@ paths: tags: - Conversations summary: Openai Delete Conversation Item - description: |- - Delete an item. - - Delete a conversation item. operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete responses: '200': - description: The deleted item resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationItemDeletedResource' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2909,5792 +2087,44 @@ paths: type: string description: 'Path parameter: item_id' components: + responses: + BadRequest400: + description: The request was invalid or malformed + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 400 + title: Bad Request + detail: The request was invalid or malformed + TooManyRequests429: + description: The client has sent too many requests in a given amount of time + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 429 + title: Too Many Requests + detail: You have exceeded the rate limit. Please try again later. + InternalServerError500: + description: The server encountered an unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 500 + title: Internal Server Error + detail: An unexpected error occurred + DefaultError: + description: An error occurred + content: + application/json: + schema: + $ref: '#/components/schemas/Error' schemas: - AggregationFunctionType: - type: string - enum: - - average - - weighted_average - - median - - categorical_count - - accuracy - title: AggregationFunctionType - description: Types of aggregation functions for scoring results. - AllowedToolsFilter: - properties: - tool_names: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: AllowedToolsFilter - description: Filter configuration for restricting which MCP tools can be used. - ApprovalFilter: - properties: - always: - anyOf: - - items: - type: string - type: array - - type: 'null' - never: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: ApprovalFilter - description: Filter configuration for MCP tool approval requirements. - ArrayType: - properties: - type: - type: string - const: array - title: Type - default: array - type: object - title: ArrayType - description: Parameter type for array values. - BasicScoringFnParams: - properties: - type: - type: string - const: basic - title: Type - default: basic - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: BasicScoringFnParams - description: Parameters for basic scoring function configuration. - Batch: - properties: - id: - type: string - title: Id - completion_window: - type: string - title: Completion Window - created_at: - type: integer - title: Created At - endpoint: - type: string - title: Endpoint - input_file_id: - type: string - title: Input File Id - object: - type: string - const: batch - title: Object - status: - type: string - enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled - title: Status - cancelled_at: - anyOf: - - type: integer - - type: 'null' - cancelling_at: - anyOf: - - type: integer - - type: 'null' - completed_at: - anyOf: - - type: integer - - type: 'null' - error_file_id: - anyOf: - - type: string - - type: 'null' - errors: - anyOf: - - $ref: '#/components/schemas/Errors' - title: Errors - - type: 'null' - title: Errors - expired_at: - anyOf: - - type: integer - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - failed_at: - anyOf: - - type: integer - - type: 'null' - finalizing_at: - anyOf: - - type: integer - - type: 'null' - in_progress_at: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - model: - anyOf: - - type: string - - type: 'null' - output_file_id: - anyOf: - - type: string - - type: 'null' - request_counts: - anyOf: - - $ref: '#/components/schemas/BatchRequestCounts' - title: BatchRequestCounts - - type: 'null' - title: BatchRequestCounts - usage: - anyOf: - - $ref: '#/components/schemas/BatchUsage' - title: BatchUsage - - type: 'null' - title: BatchUsage - additionalProperties: true - type: object - required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status - title: Batch - BatchError: - properties: - code: - anyOf: - - type: string - - type: 'null' - line: - anyOf: - - type: integer - - type: 'null' - message: - anyOf: - - type: string - - type: 'null' - param: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: BatchError - BatchRequestCounts: - properties: - completed: - type: integer - title: Completed - failed: - type: integer - title: Failed - total: - type: integer - title: Total - additionalProperties: true - type: object - required: - - completed - - failed - - total - title: BatchRequestCounts - BatchUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - input_tokens_details: - $ref: '#/components/schemas/InputTokensDetails' - output_tokens: - type: integer - title: Output Tokens - output_tokens_details: - $ref: '#/components/schemas/OutputTokensDetails' - total_tokens: - type: integer - title: Total Tokens - additionalProperties: true - type: object - required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens - title: BatchUsage - Benchmark: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: benchmark - title: Type - default: benchmark - dataset_id: - type: string - title: Dataset Id - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - metadata: - additionalProperties: true - type: object - title: Metadata - description: Metadata for this evaluation task - type: object - required: - - identifier - - provider_id - - dataset_id - - scoring_functions - title: Benchmark - description: A benchmark resource for evaluating model performance. - BenchmarkConfig: - properties: - eval_candidate: - $ref: '#/components/schemas/ModelCandidate' - scoring_params: - additionalProperties: - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: object - title: Scoring Params - description: Map between scoring function id and parameters for each scoring function you want to run - num_examples: - anyOf: - - type: integer - - type: 'null' - description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated - type: object - required: - - eval_candidate - title: BenchmarkConfig - description: A benchmark configuration for evaluation. - Body_openai_upload_file_v1_files_post: - properties: - file: - type: string - format: binary - title: File - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - expires_after: - anyOf: - - $ref: '#/components/schemas/ExpiresAfter' - title: ExpiresAfter - - type: 'null' - title: ExpiresAfter - type: object - required: - - file - - purpose - title: Body_openai_upload_file_v1_files_post - BooleanType: - properties: - type: - type: string - const: boolean - title: Type - default: boolean - type: object - title: BooleanType - description: Parameter type for boolean values. - ChatCompletionInputType: - properties: - type: - type: string - const: chat_completion_input - title: Type - default: chat_completion_input - type: object - title: ChatCompletionInputType - description: Parameter type for chat completion input. - Checkpoint: - properties: - identifier: - type: string - title: Identifier - created_at: - type: string - format: date-time - title: Created At - epoch: - type: integer - title: Epoch - post_training_job_id: - type: string - title: Post Training Job Id - path: - type: string - title: Path - training_metrics: - anyOf: - - $ref: '#/components/schemas/PostTrainingMetric' - title: PostTrainingMetric - - type: 'null' - title: PostTrainingMetric - type: object - required: - - identifier - - created_at - - epoch - - post_training_job_id - - path - title: Checkpoint - description: Checkpoint created during training runs. - Chunk-Input: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - Chunk-Output: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - title: string | list[ImageContentItem-Output | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - ChunkMetadata: - properties: - chunk_id: - anyOf: - - type: string - - type: 'null' - document_id: - anyOf: - - type: string - - type: 'null' - source: - anyOf: - - type: string - - type: 'null' - created_timestamp: - anyOf: - - type: integer - - type: 'null' - updated_timestamp: - anyOf: - - type: integer - - type: 'null' - chunk_window: - anyOf: - - type: string - - type: 'null' - chunk_tokenizer: - anyOf: - - type: string - - type: 'null' - chunk_embedding_model: - anyOf: - - type: string - - type: 'null' - chunk_embedding_dimension: - anyOf: - - type: integer - - type: 'null' - content_token_count: - anyOf: - - type: integer - - type: 'null' - metadata_token_count: - anyOf: - - type: integer - - type: 'null' - type: object - title: ChunkMetadata - description: |- - `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that - will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` - is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. - Use `Chunk.metadata` for metadata that will be used in the context during inference. - CompletionInputType: - properties: - type: - type: string - const: completion_input - title: Type - default: completion_input - type: object - title: CompletionInputType - description: Parameter type for completion input. - Conversation: - properties: - id: - type: string - title: Id - description: The unique ID of the conversation. - object: - type: string - const: conversation - title: Object - description: The object type, which is always conversation. - default: conversation - created_at: - type: integer - title: Created At - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. - items: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - description: Initial items to include in the conversation context. You may add up to 20 items at a time. - type: object - required: - - id - - created_at - title: Conversation - description: OpenAI-compatible conversation object. - ConversationDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted conversation identifier - object: - type: string - title: Object - description: Object type - default: conversation.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationDeletedResource - description: Response for deleted conversation. - ConversationItemDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted item identifier - object: - type: string - title: Object - description: Object type - default: conversation.item.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationItemDeletedResource - description: Response for deleted conversation item. - ConversationItemInclude: - type: string - enum: - - web_search_call.action.sources - - code_interpreter_call.outputs - - computer_call_output.output.image_url - - file_search_call.results - - message.input_image.image_url - - message.output_text.logprobs - - reasoning.encrypted_content - title: ConversationItemInclude - description: Specify additional output data to include in the model response. - ConversationItemList: - properties: - object: - type: string - title: Object - description: Object type - default: list - data: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (9 variants) - type: array - title: Data - description: List of conversation items - first_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the first item in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the last item in the list - has_more: - type: boolean - title: Has More - description: Whether there are more items available - default: false - type: object - required: - - data - title: ConversationItemList - description: List of conversation items with pagination. - DPOAlignmentConfig: - properties: - beta: - type: number - title: Beta - loss_type: - $ref: '#/components/schemas/DPOLossType' - default: sigmoid - type: object - required: - - beta - title: DPOAlignmentConfig - description: Configuration for Direct Preference Optimization (DPO) alignment. - DPOLossType: - type: string - enum: - - sigmoid - - hinge - - ipo - - kto_pair - title: DPOLossType - DataConfig: - properties: - dataset_id: - type: string - title: Dataset Id - batch_size: - type: integer - title: Batch Size - shuffle: - type: boolean - title: Shuffle - data_format: - $ref: '#/components/schemas/DatasetFormat' - validation_dataset_id: - anyOf: - - type: string - - type: 'null' - packed: - anyOf: - - type: boolean - - type: 'null' - default: false - train_on_input: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - dataset_id - - batch_size - - shuffle - - data_format - title: DataConfig - description: Configuration for training data and data loading. - Dataset: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: dataset - title: Type - default: dataset - purpose: - $ref: '#/components/schemas/DatasetPurpose' - source: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource - discriminator: - propertyName: type - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this dataset - type: object - required: - - identifier - - provider_id - - purpose - - source - title: Dataset - description: Dataset resource for storing and accessing training or evaluation data. - DatasetFormat: - type: string - enum: - - instruct - - dialog - title: DatasetFormat - description: Format of the training dataset. - DatasetPurpose: - type: string - enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - title: DatasetPurpose - description: Purpose of the dataset. Each purpose has a required input data schema. - EfficiencyConfig: - properties: - enable_activation_checkpointing: - anyOf: - - type: boolean - - type: 'null' - default: false - enable_activation_offloading: - anyOf: - - type: boolean - - type: 'null' - default: false - memory_efficient_fsdp_wrap: - anyOf: - - type: boolean - - type: 'null' - default: false - fsdp_cpu_offload: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - title: EfficiencyConfig - description: Configuration for memory and compute efficiency optimizations. - Errors: - properties: - data: - anyOf: - - items: - $ref: '#/components/schemas/BatchError' - type: array - - type: 'null' - object: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: Errors - EvaluateResponse: - properties: - generations: - items: - additionalProperties: true - type: object - type: array - title: Generations - scores: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Scores - type: object - required: - - generations - - scores - title: EvaluateResponse - description: The response from an evaluation. - ExpiresAfter: - properties: - anchor: - type: string - const: created_at - title: Anchor - seconds: - type: integer - maximum: 2592000.0 - minimum: 3600.0 - title: Seconds - type: object - required: - - anchor - - seconds - title: ExpiresAfter - description: |- - Control expiration of uploaded files. - - Params: - - anchor, must be "created_at" - - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) - GreedySamplingStrategy: - properties: - type: - type: string - const: greedy - title: Type - default: greedy - type: object - title: GreedySamplingStrategy - description: Greedy sampling strategy that selects the highest probability token at each step. - HealthInfo: - properties: - status: - $ref: '#/components/schemas/HealthStatus' - type: object - required: - - status - title: HealthInfo - description: Health status information for the service. - HealthStatus: - type: string - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - ImageContentItem-Input: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - ImageContentItem-Output: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - InputTokensDetails: - properties: - cached_tokens: - type: integer - title: Cached Tokens - additionalProperties: true - type: object - required: - - cached_tokens - title: InputTokensDetails - Job: - properties: - job_id: - type: string - title: Job Id - status: - $ref: '#/components/schemas/JobStatus' - type: object - required: - - job_id - - status - title: Job - description: A job execution instance with status tracking. - JobStatus: - type: string - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - description: Status of a job execution. - JsonType: - properties: - type: - type: string - const: json - title: Type - default: json - type: object - title: JsonType - description: Parameter type for JSON values. - LLMAsJudgeScoringFnParams: - properties: - type: - type: string - const: llm_as_judge - title: Type - default: llm_as_judge - judge_model: - type: string - title: Judge Model - prompt_template: - anyOf: - - type: string - - type: 'null' - judge_score_regexes: - items: - type: string - type: array - title: Judge Score Regexes - description: Regexes to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - required: - - judge_model - title: LLMAsJudgeScoringFnParams - description: Parameters for LLM-as-judge scoring function configuration. - ListBatchesResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/Batch' - type: array - title: Data - description: List of batch objects - first_id: - anyOf: - - type: string - - type: 'null' - description: ID of the first batch in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: ID of the last batch in the list - has_more: - type: boolean - title: Has More - description: Whether there are more batches available - default: false - type: object - required: - - data - title: ListBatchesResponse - description: Response containing a list of batch objects. - ListOpenAIChatCompletionResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIChatCompletionResponse - description: Response from listing OpenAI-compatible chat completions. - ListOpenAIFileResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIFileObject' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIFileResponse - description: Response for listing files in OpenAI Files API. - ListOpenAIResponseInputItem: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Data - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - title: ListOpenAIResponseInputItem - description: List container for OpenAI response input items. - ListOpenAIResponseObject: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseObjectWithInput-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIResponseObject - description: Paginated list of OpenAI response objects with navigation metadata. - ListPromptsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Prompt' - type: array - title: Data - type: object - required: - - data - title: ListPromptsResponse - description: Response model to list prompts. - ListProvidersResponse: - properties: - data: - items: - $ref: '#/components/schemas/ProviderInfo' - type: array - title: Data - type: object - required: - - data - title: ListProvidersResponse - description: Response containing a list of all available providers. - ListRoutesResponse: - properties: - data: - items: - $ref: '#/components/schemas/RouteInfo' - type: array - title: Data - type: object - required: - - data - title: ListRoutesResponse - description: Response containing a list of all available API routes. - ListScoringFunctionsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ScoringFn' - type: array - title: Data - type: object - required: - - data - title: ListScoringFunctionsResponse - ListShieldsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Shield' - type: array - title: Data - type: object - required: - - data - title: ListShieldsResponse - ListToolDefsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolDef' - type: array - title: Data - type: object - required: - - data - title: ListToolDefsResponse - description: Response containing a list of tool definitions. - ListToolGroupsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolGroup' - type: array - title: Data - type: object - required: - - data - title: ListToolGroupsResponse - description: Response containing a list of tool groups. - LoraFinetuningConfig: - properties: - type: - type: string - const: LoRA - title: Type - default: LoRA - lora_attn_modules: - items: - type: string - type: array - title: Lora Attn Modules - apply_lora_to_mlp: - type: boolean - title: Apply Lora To Mlp - apply_lora_to_output: - type: boolean - title: Apply Lora To Output - rank: - type: integer - title: Rank - alpha: - type: integer - title: Alpha - use_dora: - anyOf: - - type: boolean - - type: 'null' - default: false - quantize_base: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - title: LoraFinetuningConfig - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. - MCPListToolsTool: - properties: - input_schema: - additionalProperties: true - type: object - title: Input Schema - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_schema - - name - title: MCPListToolsTool - description: Tool definition returned by MCP list tools operation. - Model: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: model - title: Type - default: model - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this model - model_type: - $ref: '#/components/schemas/ModelType' - default: llm - type: object - required: - - identifier - - provider_id - title: Model - description: A model resource representing an AI model registered in Llama Stack. - ModelCandidate: - properties: - type: - type: string - const: model - title: Type - default: model - model: - type: string - title: Model - sampling_params: - $ref: '#/components/schemas/SamplingParams' - system_message: - anyOf: - - $ref: '#/components/schemas/SystemMessage' - title: SystemMessage - - type: 'null' - title: SystemMessage - type: object - required: - - model - - sampling_params - title: ModelCandidate - description: A model candidate for evaluation. - ModelType: - type: string - enum: - - llm - - embedding - - rerank - title: ModelType - description: Enumeration of supported model types in Llama Stack. - ModerationObject: - properties: - id: - type: string - title: Id - model: - type: string - title: Model - results: - items: - $ref: '#/components/schemas/ModerationObjectResults' - type: array - title: Results - type: object - required: - - id - - model - - results - title: ModerationObject - description: A moderation object. - ModerationObjectResults: - properties: - flagged: - type: boolean - title: Flagged - categories: - anyOf: - - additionalProperties: - type: boolean - type: object - - type: 'null' - category_applied_input_types: - anyOf: - - additionalProperties: - items: - type: string - type: array - type: object - - type: 'null' - category_scores: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - flagged - title: ModerationObjectResults - description: A moderation object. - NumberType: - properties: - type: - type: string - const: number - title: Type - default: number - type: object - title: NumberType - description: Parameter type for numeric values. - ObjectType: - properties: - type: - type: string - const: object - title: Type - default: object - type: object - title: ObjectType - description: Parameter type for object values. - OpenAIAssistantMessageParam-Input: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIAssistantMessageParam-Output: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIChatCompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - type: object - required: - - id - - choices - - created - - model - title: OpenAIChatCompletion - description: Response from an OpenAI-compatible chat completion request. - OpenAIChatCompletionContentPartImageParam: - properties: - type: - type: string - const: image_url - title: Type - default: image_url - image_url: - $ref: '#/components/schemas/OpenAIImageURL' - type: object - required: - - image_url - title: OpenAIChatCompletionContentPartImageParam - description: Image content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionContentPartTextParam: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: OpenAIChatCompletionContentPartTextParam - description: Text content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' - title: OpenAIAssistantMessageParam-Input - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input | ... (5 variants) - type: array - minItems: 1 - title: Messages - frequency_penalty: - anyOf: - - type: number - - type: 'null' - function_call: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - functions: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_completion_tokens: - anyOf: - - type: integer - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - response_format: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - title: OpenAIResponseFormatJSONSchema - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' - title: OpenAIResponseFormatJSONObject - discriminator: - propertyName: type - mapping: - json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' - json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' - text: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - - type: 'null' - title: Response Format - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - tool_choice: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - tools: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - top_logprobs: - anyOf: - - type: integer - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - messages - title: OpenAIChatCompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible chat completion endpoint. - OpenAIChatCompletionToolCall: - properties: - index: - anyOf: - - type: integer - - type: 'null' - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - const: function - title: Type - default: function - function: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' - title: OpenAIChatCompletionToolCallFunction - - type: 'null' - title: OpenAIChatCompletionToolCallFunction - type: object - title: OpenAIChatCompletionToolCall - description: Tool call specification for OpenAI-compatible chat completion responses. - OpenAIChatCompletionToolCallFunction: - properties: - name: - anyOf: - - type: string - - type: 'null' - arguments: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIChatCompletionToolCallFunction - description: Function call details for OpenAI-compatible tool calls. - OpenAIChatCompletionUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - completion_tokens: - type: integer - title: Completion Tokens - total_tokens: - type: integer - title: Total Tokens - prompt_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' - title: OpenAIChatCompletionUsagePromptTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsagePromptTokensDetails - completion_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' - title: OpenAIChatCompletionUsageCompletionTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsageCompletionTokensDetails - type: object - required: - - prompt_tokens - - completion_tokens - - total_tokens - title: OpenAIChatCompletionUsage - description: Usage information for OpenAI chat completion. - OpenAIChatCompletionUsageCompletionTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsageCompletionTokensDetails - description: Token details for output tokens in OpenAI chat completion usage. - OpenAIChatCompletionUsagePromptTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsagePromptTokensDetails - description: Token details for prompt tokens in OpenAI chat completion usage. - OpenAIChoice-Output: - properties: - message: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam-Output | ... (5 variants) - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - finish_reason: - type: string - title: Finish Reason - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - message - - finish_reason - - index - title: OpenAIChoice - description: A choice from an OpenAI-compatible chat completion response. - OpenAIChoiceLogprobs-Output: - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - type: object - title: OpenAIChoiceLogprobs - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - OpenAICompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAICompletionChoice-Output' - type: array - title: Choices - created: - type: integer - title: Created - model: - type: string - title: Model - object: - type: string - const: text_completion - title: Object - default: text_completion - type: object - required: - - id - - choices - - created - - model - title: OpenAICompletion - description: |- - Response from an OpenAI-compatible completion request. - - :id: The ID of the completion - :choices: List of choices - :created: The Unix timestamp in seconds when the completion was created - :model: The model that was used to generate the completion - :object: The object type, which will be "text_completion" - OpenAICompletionChoice-Output: - properties: - finish_reason: - type: string - title: Finish Reason - text: - type: string - title: Text - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - finish_reason - - text - - index - title: OpenAICompletionChoice - description: |- - A choice from an OpenAI-compatible completion response. - - :finish_reason: The reason the model stopped generating - :text: The text of the choice - :index: The index of the choice - :logprobs: (Optional) The log probabilities for the tokens in the choice - OpenAICompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - prompt: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - items: - type: integer - type: array - title: list[integer] - - items: - items: - type: integer - type: array - type: array - title: list[array] - title: string | ... (4 variants) - best_of: - anyOf: - - type: integer - - type: 'null' - echo: - anyOf: - - type: boolean - - type: 'null' - frequency_penalty: - anyOf: - - type: number - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - suffix: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - prompt - title: OpenAICompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible completion endpoint. - OpenAICompletionWithInputMessages: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - input_messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output | ... (5 variants) - type: array - title: Input Messages - type: object - required: - - id - - choices - - created - - model - - input_messages - title: OpenAICompletionWithInputMessages - OpenAICreateVectorStoreFileBatchRequestWithExtraBody: - properties: - file_ids: - items: - type: string - type: array - title: File Ids - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - additionalProperties: true - type: object - required: - - file_ids - title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: Request to create a vector store file batch with extra_body support. - OpenAICreateVectorStoreRequestWithExtraBody: - properties: - name: - anyOf: - - type: string - - type: 'null' - file_ids: - anyOf: - - items: - type: string - type: array - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - additionalProperties: true - type: object - title: OpenAICreateVectorStoreRequestWithExtraBody - description: Request to create a vector store with extra_body support. - OpenAIDeleteResponseObject: - properties: - id: - type: string - title: Id - object: - type: string - const: response - title: Object - default: response - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: OpenAIDeleteResponseObject - description: Response object confirming deletion of an OpenAI response. - OpenAIDeveloperMessageParam: - properties: - role: - type: string - const: developer - title: Role - default: developer - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIDeveloperMessageParam - description: A message from the developer in an OpenAI-compatible chat completion request. - OpenAIEmbeddingData: - properties: - object: - type: string - const: embedding - title: Object - default: embedding - embedding: - anyOf: - - items: - type: number - type: array - title: list[number] - - type: string - title: list[number] | string - index: - type: integer - title: Index - type: object - required: - - embedding - - index - title: OpenAIEmbeddingData - description: A single embedding data object from an OpenAI-compatible embeddings response. - OpenAIEmbeddingUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - total_tokens: - type: integer - title: Total Tokens - type: object - required: - - prompt_tokens - - total_tokens - title: OpenAIEmbeddingUsage - description: Usage information for an OpenAI-compatible embeddings response. - OpenAIEmbeddingsRequestWithExtraBody: - properties: - model: - type: string - title: Model - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - encoding_format: - anyOf: - - type: string - - type: 'null' - default: float - dimensions: - anyOf: - - type: integer - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - input - title: OpenAIEmbeddingsRequestWithExtraBody - description: Request parameters for OpenAI-compatible embeddings endpoint. - OpenAIEmbeddingsResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/OpenAIEmbeddingData' - type: array - title: Data - model: - type: string - title: Model - usage: - $ref: '#/components/schemas/OpenAIEmbeddingUsage' - type: object - required: - - data - - model - - usage - title: OpenAIEmbeddingsResponse - description: Response from an OpenAI-compatible embeddings request. - OpenAIFile: - properties: - type: - type: string - const: file - title: Type - default: file - file: - $ref: '#/components/schemas/OpenAIFileFile' - type: object - required: - - file - title: OpenAIFile - OpenAIFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - const: file - title: Object - default: file - deleted: - type: boolean - title: Deleted - type: object - required: - - id - - deleted - title: OpenAIFileDeleteResponse - description: Response for deleting a file in OpenAI Files API. - OpenAIFileFile: - properties: - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIFileFile - OpenAIFileObject: - properties: - object: - type: string - const: file - title: Object - default: file - id: - type: string - title: Id - bytes: - type: integer - title: Bytes - created_at: - type: integer - title: Created At - expires_at: - type: integer - title: Expires At - filename: - type: string - title: Filename - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - type: object - required: - - id - - bytes - - created_at - - expires_at - - filename - - purpose - title: OpenAIFileObject - description: OpenAI File object as defined in the OpenAI Files API. - OpenAIFilePurpose: - type: string - enum: - - assistants - - batch - title: OpenAIFilePurpose - description: Valid purpose values for OpenAI Files API. - OpenAIImageURL: - properties: - url: - type: string - title: Url - detail: - anyOf: - - type: string - - type: 'null' - type: object - required: - - url - title: OpenAIImageURL - description: Image URL specification for OpenAI-compatible chat completion messages. - OpenAIJSONSchema: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: OpenAIJSONSchema - description: JSON schema specification for OpenAI-compatible structured response format. - OpenAIListModelsResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIModel' - type: array - title: Data - type: object - required: - - data - title: OpenAIListModelsResponse - OpenAIModel: - properties: - id: - type: string - title: Id - object: - type: string - const: model - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - custom_metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - id - - created - - owned_by - title: OpenAIModel - description: |- - A model from OpenAI. - - :id: The ID of the model - :object: The object type, which will be "model" - :created: The Unix timestamp in seconds when the model was created - :owned_by: The owner of the model - :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata - OpenAIResponseAnnotationCitation: - properties: - type: - type: string - const: url_citation - title: Type - default: url_citation - end_index: - type: integer - title: End Index - start_index: - type: integer - title: Start Index - title: - type: string - title: Title - url: - type: string - title: Url - type: object - required: - - end_index - - start_index - - title - - url - title: OpenAIResponseAnnotationCitation - description: URL citation annotation for referencing external web resources. - OpenAIResponseAnnotationContainerFileCitation: - properties: - type: - type: string - const: container_file_citation - title: Type - default: container_file_citation - container_id: - type: string - title: Container Id - end_index: - type: integer - title: End Index - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - start_index: - type: integer - title: Start Index - type: object - required: - - container_id - - end_index - - file_id - - filename - - start_index - title: OpenAIResponseAnnotationContainerFileCitation - OpenAIResponseAnnotationFileCitation: - properties: - type: - type: string - const: file_citation - title: Type - default: file_citation - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - index: - type: integer - title: Index - type: object - required: - - file_id - - filename - - index - title: OpenAIResponseAnnotationFileCitation - description: File citation annotation for referencing specific files in response content. - OpenAIResponseAnnotationFilePath: - properties: - type: - type: string - const: file_path - title: Type - default: file_path - file_id: - type: string - title: File Id - index: - type: integer - title: Index - type: object - required: - - file_id - - index - title: OpenAIResponseAnnotationFilePath - OpenAIResponseContentPartRefusal: - properties: - type: - type: string - const: refusal - title: Type - default: refusal - refusal: - type: string - title: Refusal - type: object - required: - - refusal - title: OpenAIResponseContentPartRefusal - description: Refusal content within a streamed response part. - OpenAIResponseError: - properties: - code: - type: string - title: Code - message: - type: string - title: Message - type: object - required: - - code - - message - title: OpenAIResponseError - description: Error details for failed OpenAI response requests. - OpenAIResponseFormatJSONObject: - properties: - type: - type: string - const: json_object - title: Type - default: json_object - type: object - title: OpenAIResponseFormatJSONObject - description: JSON object response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatJSONSchema: - properties: - type: - type: string - const: json_schema - title: Type - default: json_schema - json_schema: - $ref: '#/components/schemas/OpenAIJSONSchema' - type: object - required: - - json_schema - title: OpenAIResponseFormatJSONSchema - description: JSON schema response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatText: - properties: - type: - type: string - const: text - title: Type - default: text - type: object - title: OpenAIResponseFormatText - description: Text response format for OpenAI-compatible chat completion requests. - OpenAIResponseInputFunctionToolCallOutput: - properties: - call_id: - type: string - title: Call Id - output: - type: string - title: Output - type: - type: string - const: function_call_output - title: Type - default: function_call_output - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - output - title: OpenAIResponseInputFunctionToolCallOutput - description: This represents the output of a function call that gets passed back to the model. - OpenAIResponseInputMessageContentFile: - properties: - type: - type: string - const: input_file - title: Type - default: input_file - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - file_url: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentFile - description: File content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentImage: - properties: - detail: - title: Detail - default: auto - type: string - enum: - - low - - high - - auto - type: - type: string - const: input_image - title: Type - default: input_image - file_id: - anyOf: - - type: string - - type: 'null' - image_url: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentImage - description: Image content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentText: - properties: - text: - type: string - title: Text - type: - type: string - const: input_text - title: Type - default: input_text - type: object - required: - - text - title: OpenAIResponseInputMessageContentText - description: Text content for input messages in OpenAI response format. - OpenAIResponseInputToolFileSearch: - properties: - type: - type: string - const: file_search - title: Type - default: file_search - vector_store_ids: - items: - type: string - type: array - title: Vector Store Ids - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - maximum: 50.0 - minimum: 1.0 - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - type: object - required: - - vector_store_ids - title: OpenAIResponseInputToolFileSearch - description: File search tool configuration for OpenAI response inputs. - OpenAIResponseInputToolFunction: - properties: - type: - type: string - const: function - title: Type - default: function - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - required: - - name - - parameters - title: OpenAIResponseInputToolFunction - description: Function tool configuration for OpenAI response inputs. - OpenAIResponseInputToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - server_url: - type: string - title: Server Url - headers: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - require_approval: - anyOf: - - type: string - const: always - - type: string - const: never - - $ref: '#/components/schemas/ApprovalFilter' - title: ApprovalFilter - title: string | ApprovalFilter - default: never - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - - server_url - title: OpenAIResponseInputToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. - OpenAIResponseInputToolWebSearch: - properties: - type: - title: Type - default: web_search - type: string - enum: - - web_search - - web_search_preview - - web_search_preview_2025_03_11 - - web_search_2025_08_26 - search_context_size: - anyOf: - - type: string - pattern: ^low|medium|high$ - - type: 'null' - default: medium - type: object - title: OpenAIResponseInputToolWebSearch - description: Web search tool configuration for OpenAI response inputs. - OpenAIResponseMCPApprovalRequest: - properties: - arguments: - type: string - title: Arguments - id: - type: string - title: Id - name: - type: string - title: Name - server_label: - type: string - title: Server Label - type: - type: string - const: mcp_approval_request - title: Type - default: mcp_approval_request - type: object - required: - - arguments - - id - - name - - server_label - title: OpenAIResponseMCPApprovalRequest - description: A request for human approval of a tool invocation. - OpenAIResponseMCPApprovalResponse: - properties: - approval_request_id: - type: string - title: Approval Request Id - approve: - type: boolean - title: Approve - type: - type: string - const: mcp_approval_response - title: Type - default: mcp_approval_response - id: - anyOf: - - type: string - - type: 'null' - reason: - anyOf: - - type: string - - type: 'null' - type: object - required: - - approval_request_id - - approve - title: OpenAIResponseMCPApprovalResponse - description: A response to an MCP approval request. - OpenAIResponseMessage-Input: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseMessage-Output: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseObject: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - created_at - - id - - model - - output - - status - title: OpenAIResponseObject - description: Complete OpenAI response object containing generation results and metadata. - OpenAIResponseObjectWithInput-Output: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - input: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Input - type: object - required: - - created_at - - id - - model - - output - - status - - input - title: OpenAIResponseObjectWithInput - description: OpenAI response object extended with input context information. - OpenAIResponseOutputMessageContentOutputText: - properties: - text: - type: string - title: Text - type: - type: string - const: output_text - title: Type - default: output_text - annotations: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - title: OpenAIResponseAnnotationFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - title: OpenAIResponseAnnotationContainerFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - title: OpenAIResponseAnnotationFilePath - discriminator: - propertyName: type - mapping: - container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' - url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - type: array - title: Annotations - type: object - required: - - text - title: OpenAIResponseOutputMessageContentOutputText - OpenAIResponseOutputMessageFileSearchToolCall: - properties: - id: - type: string - title: Id - queries: - items: - type: string - type: array - title: Queries - status: - type: string - title: Status - type: - type: string - const: file_search_call - title: Type - default: file_search_call - results: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' - type: array - - type: 'null' - type: object - required: - - id - - queries - - status - title: OpenAIResponseOutputMessageFileSearchToolCall - description: File search tool call output message for OpenAI responses. - OpenAIResponseOutputMessageFileSearchToolCallResults: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - text: - type: string - title: Text - type: object - required: - - attributes - - file_id - - filename - - score - - text - title: OpenAIResponseOutputMessageFileSearchToolCallResults - description: Search results returned by the file search operation. - OpenAIResponseOutputMessageFunctionToolCall: - properties: - call_id: - type: string - title: Call Id - name: - type: string - title: Name - arguments: - type: string - title: Arguments - type: - type: string - const: function_call - title: Type - default: function_call - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - name - - arguments - title: OpenAIResponseOutputMessageFunctionToolCall - description: Function tool call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPCall: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_call - title: Type - default: mcp_call - arguments: - type: string - title: Arguments - name: - type: string - title: Name - server_label: - type: string - title: Server Label - error: - anyOf: - - type: string - - type: 'null' - output: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - - arguments - - name - - server_label - title: OpenAIResponseOutputMessageMCPCall - description: Model Context Protocol (MCP) call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPListTools: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_list_tools - title: Type - default: mcp_list_tools - server_label: - type: string - title: Server Label - tools: - items: - $ref: '#/components/schemas/MCPListToolsTool' - type: array - title: Tools - type: object - required: - - id - - server_label - - tools - title: OpenAIResponseOutputMessageMCPListTools - description: MCP list tools output message containing available tools from an MCP server. - OpenAIResponseOutputMessageWebSearchToolCall: - properties: - id: - type: string - title: Id - status: - type: string - title: Status - type: - type: string - const: web_search_call - title: Type - default: web_search_call - type: object - required: - - id - - status - title: OpenAIResponseOutputMessageWebSearchToolCall - description: Web search tool call output message for OpenAI responses. - OpenAIResponsePrompt: - properties: - id: - type: string - title: Id - variables: - anyOf: - - additionalProperties: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: object - - type: 'null' - version: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - title: OpenAIResponsePrompt - description: OpenAI compatible Prompt object that is used in OpenAI responses. - OpenAIResponseText: - properties: - format: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseTextFormat' - title: OpenAIResponseTextFormat - - type: 'null' - title: OpenAIResponseTextFormat - type: object - title: OpenAIResponseText - description: Text response configuration for OpenAI responses. - OpenAIResponseTextFormat: - properties: - type: - title: Type - type: string - enum: - - text - - json_schema - - json_object - default: text - name: - anyOf: - - type: string - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - title: OpenAIResponseTextFormat - description: Configuration for Responses API text format. - OpenAIResponseToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - title: OpenAIResponseToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. - OpenAIResponseUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - output_tokens: - type: integer - title: Output Tokens - total_tokens: - type: integer - title: Total Tokens - input_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' - title: OpenAIResponseUsageInputTokensDetails - - type: 'null' - title: OpenAIResponseUsageInputTokensDetails - output_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' - title: OpenAIResponseUsageOutputTokensDetails - - type: 'null' - title: OpenAIResponseUsageOutputTokensDetails - type: object - required: - - input_tokens - - output_tokens - - total_tokens - title: OpenAIResponseUsage - description: Usage information for OpenAI response. - OpenAIResponseUsageInputTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageInputTokensDetails - description: Token details for input tokens in OpenAI response usage. - OpenAIResponseUsageOutputTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageOutputTokensDetails - description: Token details for output tokens in OpenAI response usage. - OpenAISystemMessageParam: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAISystemMessageParam - description: A system message providing instructions or context to the model. - OpenAITokenLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - top_logprobs: - items: - $ref: '#/components/schemas/OpenAITopLogProb' - type: array - title: Top Logprobs - type: object - required: - - token - - logprob - - top_logprobs - title: OpenAITokenLogProb - description: |- - The log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - :top_logprobs: The top log probabilities for the token - OpenAIToolMessageParam: - properties: - role: - type: string - const: tool - title: Role - default: tool - tool_call_id: - type: string - title: Tool Call Id - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - type: object - required: - - tool_call_id - - content - title: OpenAIToolMessageParam - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. - OpenAITopLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - type: object - required: - - token - - logprob - title: OpenAITopLogProb - description: |- - The top log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - OpenAIUserMessageParam-Input: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OpenAIUserMessageParam-Output: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OptimizerConfig: - properties: - optimizer_type: - $ref: '#/components/schemas/OptimizerType' - lr: - type: number - title: Lr - weight_decay: - type: number - title: Weight Decay - num_warmup_steps: - type: integer - title: Num Warmup Steps - type: object - required: - - optimizer_type - - lr - - weight_decay - - num_warmup_steps - title: OptimizerConfig - description: Configuration parameters for the optimization algorithm. - OptimizerType: - type: string - enum: - - adam - - adamw - - sgd - title: OptimizerType - description: Available optimizer algorithms for training. - Order: - type: string - enum: - - asc - - desc - title: Order - description: Sort order for paginated responses. - OutputTokensDetails: - properties: - reasoning_tokens: - type: integer - title: Reasoning Tokens - additionalProperties: true - type: object - required: - - reasoning_tokens - title: OutputTokensDetails - PaginatedResponse: - properties: - data: - items: - additionalProperties: true - type: object - type: array - title: Data - has_more: - type: boolean - title: Has More - url: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - - has_more - title: PaginatedResponse - description: A generic paginated response that follows a simple format. - PostTrainingJobArtifactsResponse: - properties: - job_uuid: - type: string - title: Job Uuid - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - title: PostTrainingJobArtifactsResponse - description: Artifacts of a finetuning job. - PostTrainingJobStatusResponse: - properties: - job_uuid: - type: string - title: Job Uuid - status: - $ref: '#/components/schemas/JobStatus' - scheduled_at: - anyOf: - - type: string - format: date-time - - type: 'null' - started_at: - anyOf: - - type: string - format: date-time - - type: 'null' - completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' - resources_allocated: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - - status - title: PostTrainingJobStatusResponse - description: Status of a finetuning job. - PostTrainingMetric: - properties: - epoch: - type: integer - title: Epoch - train_loss: - type: number - title: Train Loss - validation_loss: - type: number - title: Validation Loss - perplexity: - type: number - title: Perplexity - type: object - required: - - epoch - - train_loss - - validation_loss - - perplexity - title: PostTrainingMetric - description: Training metrics captured during post-training jobs. - Prompt: - properties: - prompt: - anyOf: - - type: string - - type: 'null' - description: The system prompt with variable placeholders - version: - type: integer - minimum: 1.0 - title: Version - description: Version (integer starting at 1, incremented on save) - prompt_id: - type: string - title: Prompt Id - description: Unique identifier in format 'pmpt_<48-digit-hash>' - variables: - items: - type: string - type: array - title: Variables - description: List of variable names that can be used in the prompt template - is_default: - type: boolean - title: Is Default - description: Boolean indicating whether this version is the default version - default: false - type: object - required: - - version - - prompt_id - title: Prompt - description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. - ProviderInfo: - properties: - api: - type: string - title: Api - provider_id: - type: string - title: Provider Id - provider_type: - type: string - title: Provider Type - config: - additionalProperties: true - type: object - title: Config - health: - additionalProperties: true - type: object - title: Health - type: object - required: - - api - - provider_id - - provider_type - - config - - health - title: ProviderInfo - description: Information about a registered provider including its configuration and health status. - QATFinetuningConfig: - properties: - type: - type: string - const: QAT - title: Type - default: QAT - quantizer_name: - type: string - title: Quantizer Name - group_size: - type: integer - title: Group Size - type: object - required: - - quantizer_name - - group_size - title: QATFinetuningConfig - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. - QueryChunksResponse: - properties: - chunks: - items: - $ref: '#/components/schemas/Chunk-Output' - type: array - title: Chunks - scores: - items: - type: number - type: array - title: Scores - type: object - required: - - chunks - - scores - title: QueryChunksResponse - description: Response from querying chunks in a vector database. - RegexParserScoringFnParams: - properties: - type: - type: string - const: regex_parser - title: Type - default: regex_parser - parsing_regexes: - items: - type: string - type: array - title: Parsing Regexes - description: Regex to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: RegexParserScoringFnParams - description: Parameters for regex parser scoring function configuration. - RerankData: - properties: - index: - type: integer - title: Index - relevance_score: - type: number - title: Relevance Score - type: object - required: - - index - - relevance_score - title: RerankData - description: A single rerank result from a reranking response. - RerankResponse: - properties: - data: - items: - $ref: '#/components/schemas/RerankData' - type: array - title: Data - type: object - required: - - data - title: RerankResponse - description: Response from a reranking request. - RouteInfo: - properties: - route: - type: string - title: Route - method: - type: string - title: Method - provider_types: - items: - type: string - type: array - title: Provider Types - type: object - required: - - route - - method - - provider_types - title: RouteInfo - description: Information about an API route including its path, method, and implementing providers. - RowsDataSource: - properties: - type: - type: string - const: rows - title: Type - default: rows - rows: - items: - additionalProperties: true - type: object - type: array - title: Rows - type: object - required: - - rows - title: RowsDataSource - description: A dataset stored in rows. - RunShieldResponse: - properties: - violation: - anyOf: - - $ref: '#/components/schemas/SafetyViolation' - title: SafetyViolation - - type: 'null' - title: SafetyViolation - type: object - title: RunShieldResponse - description: Response from running a safety shield. - SafetyViolation: - properties: - violation_level: - $ref: '#/components/schemas/ViolationLevel' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - violation_level - title: SafetyViolation - description: Details of a safety violation detected by content moderation. - SamplingParams: - properties: - strategy: - oneOf: - - $ref: '#/components/schemas/GreedySamplingStrategy' - title: GreedySamplingStrategy - - $ref: '#/components/schemas/TopPSamplingStrategy' - title: TopPSamplingStrategy - - $ref: '#/components/schemas/TopKSamplingStrategy' - title: TopKSamplingStrategy - title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy - discriminator: - propertyName: type - mapping: - greedy: '#/components/schemas/GreedySamplingStrategy' - top_k: '#/components/schemas/TopKSamplingStrategy' - top_p: '#/components/schemas/TopPSamplingStrategy' - max_tokens: - anyOf: - - type: integer - - type: 'null' - repetition_penalty: - anyOf: - - type: number - - type: 'null' - default: 1.0 - stop: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: SamplingParams - description: Sampling parameters. - ScoreBatchResponse: - properties: - dataset_id: - anyOf: - - type: string - - type: 'null' - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreBatchResponse - description: Response from batch scoring operations on datasets. - ScoreResponse: - properties: - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreResponse - description: The response from scoring. - ScoringFn: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: scoring_function - title: Type - default: scoring_function - description: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this definition - return_type: - oneOf: - - $ref: '#/components/schemas/StringType' - title: StringType - - $ref: '#/components/schemas/NumberType' - title: NumberType - - $ref: '#/components/schemas/BooleanType' - title: BooleanType - - $ref: '#/components/schemas/ArrayType' - title: ArrayType - - $ref: '#/components/schemas/ObjectType' - title: ObjectType - - $ref: '#/components/schemas/JsonType' - title: JsonType - - $ref: '#/components/schemas/UnionType' - title: UnionType - - $ref: '#/components/schemas/ChatCompletionInputType' - title: ChatCompletionInputType - - $ref: '#/components/schemas/CompletionInputType' - title: CompletionInputType - title: StringType | ... (9 variants) - description: The return type of the deterministic function - discriminator: - propertyName: type - mapping: - array: '#/components/schemas/ArrayType' - boolean: '#/components/schemas/BooleanType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - json: '#/components/schemas/JsonType' - number: '#/components/schemas/NumberType' - object: '#/components/schemas/ObjectType' - string: '#/components/schemas/StringType' - union: '#/components/schemas/UnionType' - params: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: Params - description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval - type: object - required: - - identifier - - provider_id - - return_type - title: ScoringFn - description: A scoring function resource for evaluating model outputs. - ScoringResult: - properties: - score_rows: - items: - additionalProperties: true - type: object - type: array - title: Score Rows - aggregated_results: - additionalProperties: true - type: object - title: Aggregated Results - type: object - required: - - score_rows - - aggregated_results - title: ScoringResult - description: A scoring result for a single row. - SearchRankingOptions: - properties: - ranker: - anyOf: - - type: string - - type: 'null' - score_threshold: - anyOf: - - type: number - - type: 'null' - default: 0.0 - type: object - title: SearchRankingOptions - description: Options for ranking and filtering search results. - Shield: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: shield - title: Type - default: shield - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: Shield - description: A safety shield resource that can be used to check content. - StringType: - properties: - type: - type: string - const: string - title: Type - default: string - type: object - title: StringType - description: Parameter type for string values. - SystemMessage: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - type: object - required: - - content - title: SystemMessage - description: A system message providing instructions or context to the model. - TextContentItem: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: TextContentItem - description: A text content item - ToolDef: - properties: - toolgroup_id: - anyOf: - - type: string - - type: 'null' - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - input_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - output_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - name - title: ToolDef - description: Tool definition used in runtime contexts. - ToolGroup: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: tool_group - title: Type - default: tool_group - mcp_endpoint: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - args: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: ToolGroup - description: A group of related tools managed together. - ToolInvocationResult: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - - type: 'null' - title: string | list[ImageContentItem-Output | TextContentItem] - error_message: - anyOf: - - type: string - - type: 'null' - error_code: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: ToolInvocationResult - description: Result of a tool invocation. - TopKSamplingStrategy: - properties: - type: - type: string - const: top_k - title: Type - default: top_k - top_k: - type: integer - minimum: 1.0 - title: Top K - type: object - required: - - top_k - title: TopKSamplingStrategy - description: Top-k sampling strategy that restricts sampling to the k most likely tokens. - TopPSamplingStrategy: - properties: - type: - type: string - const: top_p - title: Type - default: top_p - temperature: - anyOf: - - type: number - minimum: 0.0 - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - default: 0.95 - type: object - required: - - temperature - title: TopPSamplingStrategy - description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. - TrainingConfig: - properties: - n_epochs: - type: integer - title: N Epochs - max_steps_per_epoch: - type: integer - title: Max Steps Per Epoch - default: 1 - gradient_accumulation_steps: - type: integer - title: Gradient Accumulation Steps - default: 1 - max_validation_steps: - anyOf: - - type: integer - - type: 'null' - default: 1 - data_config: - anyOf: - - $ref: '#/components/schemas/DataConfig' - title: DataConfig - - type: 'null' - title: DataConfig - optimizer_config: - anyOf: - - $ref: '#/components/schemas/OptimizerConfig' - title: OptimizerConfig - - type: 'null' - title: OptimizerConfig - efficiency_config: - anyOf: - - $ref: '#/components/schemas/EfficiencyConfig' - title: EfficiencyConfig - - type: 'null' - title: EfficiencyConfig - dtype: - anyOf: - - type: string - - type: 'null' - default: bf16 - type: object - required: - - n_epochs - title: TrainingConfig - description: Comprehensive configuration for the training process. - URIDataSource: - properties: - type: - type: string - const: uri - title: Type - default: uri - uri: - type: string - title: Uri - type: object - required: - - uri - title: URIDataSource - description: A dataset that can be obtained from a URI. - URL: - properties: - uri: - type: string - title: Uri - type: object - required: - - uri - title: URL - description: A URL reference to external content. - UnionType: - properties: - type: - type: string - const: union - title: Type - default: union - type: object - title: UnionType - description: Parameter type for union values. - VectorStoreChunkingStrategyAuto: - properties: - type: - type: string - const: auto - title: Type - default: auto - type: object - title: VectorStoreChunkingStrategyAuto - description: Automatic chunking strategy for vector store files. - VectorStoreChunkingStrategyStatic: - properties: - type: - type: string - const: static - title: Type - default: static - static: - $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - type: object - required: - - static - title: VectorStoreChunkingStrategyStatic - description: Static chunking strategy with configurable parameters. - VectorStoreChunkingStrategyStaticConfig: - properties: - chunk_overlap_tokens: - type: integer - title: Chunk Overlap Tokens - default: 400 - max_chunk_size_tokens: - type: integer - maximum: 4096.0 - minimum: 100.0 - title: Max Chunk Size Tokens - default: 800 - type: object - title: VectorStoreChunkingStrategyStaticConfig - description: Configuration for static chunking strategy. - VectorStoreContent: - properties: - type: - type: string - const: text - title: Type - text: - type: string - title: Text - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - type - - text - title: VectorStoreContent - description: Content item from a vector store file or search result. - VectorStoreDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreDeleteResponse - description: Response from deleting a vector store. - VectorStoreFileBatchObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file_batch - created_at: - type: integer - title: Created At - vector_store_id: - type: string - title: Vector Store Id - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - type: object - required: - - id - - created_at - - vector_store_id - - status - - file_counts - title: VectorStoreFileBatchObject - description: OpenAI Vector Store File Batch object. - VectorStoreFileContentResponse: - properties: - object: - type: string - const: vector_store.file_content.page - title: Object - default: vector_store.file_content.page - data: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - title: VectorStoreFileContentResponse - description: Represents the parsed content of a vector store file. - VectorStoreFileCounts: - properties: - completed: - type: integer - title: Completed - cancelled: - type: integer - title: Cancelled - failed: - type: integer - title: Failed - in_progress: - type: integer - title: In Progress - total: - type: integer - title: Total - type: object - required: - - completed - - cancelled - - failed - - in_progress - - total - title: VectorStoreFileCounts - description: File processing status counts for a vector store. - VectorStoreFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreFileDeleteResponse - description: Response from deleting a vector store file. - VectorStoreFileLastError: - properties: - code: - title: Code - type: string - enum: - - server_error - - rate_limit_exceeded - default: server_error - message: - type: string - title: Message - type: object - required: - - code - - message - title: VectorStoreFileLastError - description: Error information for failed vector store file processing. - VectorStoreFileObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file - attributes: - additionalProperties: true - type: object - title: Attributes - chunking_strategy: - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - created_at: - type: integer - title: Created At - last_error: - anyOf: - - $ref: '#/components/schemas/VectorStoreFileLastError' - title: VectorStoreFileLastError - - type: 'null' - title: VectorStoreFileLastError - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - vector_store_id: - type: string - title: Vector Store Id - type: object - required: - - id - - chunking_strategy - - created_at - - status - - vector_store_id - title: VectorStoreFileObject - description: OpenAI Vector Store File object. - VectorStoreFilesListInBatchResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreFilesListInBatchResponse - description: Response from listing files in a vector store file batch. - VectorStoreListFilesResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListFilesResponse - description: Response from listing files in a vector store. - VectorStoreListResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListResponse - description: Response from listing vector stores. - VectorStoreObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store - created_at: - type: integer - title: Created At - name: - anyOf: - - type: string - - type: 'null' - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - status: - type: string - title: Status - default: completed - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - last_active_at: - anyOf: - - type: integer - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - id - - created_at - - file_counts - title: VectorStoreObject - description: OpenAI Vector Store object. - VectorStoreSearchResponse-Output: - properties: - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - attributes: - anyOf: - - additionalProperties: - anyOf: - - type: string - - type: number - - type: boolean - title: string | number | boolean - type: object - - type: 'null' - content: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Content - type: object - required: - - file_id - - filename - - score - - content - title: VectorStoreSearchResponse - description: Response from searching a vector store. - VectorStoreSearchResponsePage: - properties: - object: - type: string - title: Object - default: vector_store.search_results.page - search_query: - items: - type: string - type: array - title: Search Query - data: - items: - $ref: '#/components/schemas/VectorStoreSearchResponse-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - search_query - - data - title: VectorStoreSearchResponsePage - description: Paginated response from searching a vector store. - VersionInfo: - properties: - version: - type: string - title: Version - type: object - required: - - version - title: VersionInfo - description: Version information for the service. - ViolationLevel: - type: string - enum: - - info - - warn - - error - title: ViolationLevel - description: Severity level of a safety violation. - _URLOrData: - properties: - url: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - data: - anyOf: - - type: string - - type: 'null' - contentEncoding: base64 - type: object - title: _URLOrData - description: A URL or a base64 encoded string - _batches_Request: - properties: - input_file_id: - type: string - title: Input File Id - endpoint: - type: string - title: Endpoint - completion_window: - type: string - const: 24h - title: Completion Window - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - idempotency_key: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_file_id - - endpoint - - completion_window - title: _batches_Request - _conversations_Request: - properties: - items: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - type: object - title: _conversations_Request - _conversations_conversation_id_Request: - properties: - metadata: - additionalProperties: - type: string - type: object - title: Metadata - type: object - required: - - metadata - title: _conversations_conversation_id_Request - _conversations_conversation_id_items_Request: - properties: - items: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - title: Items - type: object - required: - - items - title: _conversations_conversation_id_items_Request - _moderations_Request: - properties: - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - model: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input - title: _moderations_Request - _prompts_Request: - properties: - prompt: - type: string - title: Prompt - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - required: - - prompt - title: _prompts_Request - _prompts_prompt_id_Request: - properties: - prompt: - type: string - title: Prompt - version: - type: integer - title: Version - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - set_as_default: - type: boolean - title: Set As Default - default: true - type: object - required: - - prompt - - version - title: _prompts_prompt_id_Request - _prompts_prompt_id_set_default_version_Request: - properties: - version: - type: integer - title: Version - type: object - required: - - version - title: _prompts_prompt_id_set_default_version_Request - _responses_Request: - properties: - input: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIResponseMessageInputUnion' - type: array - title: list[OpenAIResponseMessageInputUnion] - title: string | list[OpenAIResponseMessageInputUnion] - model: - type: string - title: Model - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - instructions: - anyOf: - - type: string - - type: 'null' - previous_response_id: - anyOf: - - type: string - - type: 'null' - conversation: - anyOf: - - type: string - - type: 'null' - store: - anyOf: - - type: boolean - - type: 'null' - default: true - stream: - anyOf: - - type: boolean - - type: 'null' - default: false - temperature: - anyOf: - - type: number - - type: 'null' - text: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseText' - title: OpenAIResponseText - - type: 'null' - title: OpenAIResponseText - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' - title: OpenAIResponseInputToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseInputToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - include: - anyOf: - - items: - type: string - type: array - - type: 'null' - max_infer_iters: - anyOf: - - type: integer - - type: 'null' - default: 10 - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - input - - model - title: _responses_Request - _scoring_score_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - type: object - required: - - input_rows - - scoring_functions - title: _scoring_score_Request - _scoring_score_batch_Request: - properties: - dataset_id: - type: string - title: Dataset Id - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - save_results_dataset: - type: boolean - title: Save Results Dataset - default: false - type: object - required: - - dataset_id - - scoring_functions - title: _scoring_score_batch_Request - _tool_runtime_invoke_Request: - properties: - tool_name: - type: string - title: Tool Name - kwargs: - additionalProperties: true - type: object - title: Kwargs - type: object - required: - - tool_name - - kwargs - title: _tool_runtime_invoke_Request - _vector_io_query_Request: - properties: - vector_store_id: - type: string - title: Vector Store Id - query: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - vector_store_id - - query - title: _vector_io_query_Request - _vector_stores_vector_store_id_Request: - properties: - name: - anyOf: - - type: string - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: _vector_stores_vector_store_id_Request - _vector_stores_vector_store_id_files_Request: - properties: - file_id: - type: string - title: File Id - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - type: object - required: - - file_id - title: _vector_stores_vector_store_id_files_Request - _vector_stores_vector_store_id_files_file_id_Request: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - type: object - required: - - attributes - title: _vector_stores_vector_store_id_files_file_id_Request - _vector_stores_vector_store_id_search_Request: - properties: - query: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - rewrite_query: - anyOf: - - type: boolean - - type: 'null' - default: false - search_mode: - anyOf: - - type: string - - type: 'null' - default: vector - type: object - required: - - query - title: _vector_stores_vector_store_id_search_Request - Error: - description: Error response from the API. Roughly follows RFC 7807. - properties: - status: - title: Status - type: integer - title: - title: Title - type: string - detail: - title: Detail - type: string - instance: - anyOf: - - type: string - - type: 'null' - nullable: true - required: - - status - - title - - detail - title: Error - type: object ImageContentItem: description: A image content item properties: @@ -8709,6 +2139,49 @@ components: - image title: ImageContentItem type: object + TextContentItem: + description: A text content item + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextContentItem + type: object + URL: + description: A URL reference to external content. + properties: + uri: + title: Uri + type: string + required: + - uri + title: URL + type: object + _URLOrData: + description: A URL or a base64 encoded string + properties: + url: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + data: + anyOf: + - type: string + - type: 'null' + contentEncoding: base64 + nullable: true + title: _URLOrData + type: object InterleavedContentItem: discriminator: mapping: @@ -8750,110 +2223,54 @@ components: type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] - BuiltinTool: - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - title: BuiltinTool - type: string - ImageDelta: - description: An image content delta for streaming responses. + GreedySamplingStrategy: + description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: - const: image - default: image + const: greedy + default: greedy title: Type type: string - image: - format: binary - title: Image - type: string - required: - - image - title: ImageDelta + title: GreedySamplingStrategy type: object - TextDelta: - description: A text content delta for streaming responses. + TopKSamplingStrategy: + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: - const: text - default: text + const: top_k + default: top_k title: Type type: string - text: - title: Text - type: string + top_k: + minimum: 1 + title: Top K + type: integer required: - - text - title: TextDelta + - top_k + title: TopKSamplingStrategy type: object - ToolCall: + TopPSamplingStrategy: + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: - call_id: - title: Call Id + type: + const: top_p + default: top_p + title: Type type: string - tool_name: + temperature: anyOf: - - $ref: '#/components/schemas/BuiltinTool' - title: BuiltinTool - - type: string - title: BuiltinTool | string - arguments: - title: Arguments - type: string - required: - - call_id - - tool_name - - arguments - title: ToolCall - type: object - ToolCallDelta: - description: A tool call content delta for streaming responses. - properties: - type: - const: tool_call - default: tool_call - title: Type - type: string - tool_call: + - type: number + minimum: 0.0 + - type: 'null' + top_p: anyOf: - - type: string - - $ref: '#/components/schemas/ToolCall' - title: ToolCall - title: string | ToolCall - parse_status: - $ref: '#/components/schemas/ToolCallParseStatus' + - type: number + - type: 'null' + default: 0.95 required: - - tool_call - - parse_status - title: ToolCallDelta + - temperature + title: TopPSamplingStrategy type: object - ToolCallParseStatus: - description: Status of tool call parsing during streaming. - enum: - - started - - in_progress - - failed - - succeeded - title: ToolCallParseStatus - type: string - ContentDelta: - discriminator: - mapping: - image: '#/components/schemas/ImageDelta' - text: '#/components/schemas/TextDelta' - tool_call: '#/components/schemas/ToolCallDelta' - propertyName: type - oneOf: - - $ref: '#/components/schemas/TextDelta' - title: TextDelta - - $ref: '#/components/schemas/ImageDelta' - title: ImageDelta - - $ref: '#/components/schemas/ToolCallDelta' - title: ToolCallDelta - title: TextDelta | ImageDelta | ToolCallDelta SamplingStrategy: discriminator: mapping: @@ -8913,6 +2330,82 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat + OpenAIChatCompletionContentPartImageParam: + description: Image content part for OpenAI-compatible chat completion messages. + properties: + type: + const: image_url + default: image_url + title: Type + type: string + image_url: + $ref: '#/components/schemas/OpenAIImageURL' + required: + - image_url + title: OpenAIChatCompletionContentPartImageParam + type: object + OpenAIChatCompletionContentPartTextParam: + description: Text content part for OpenAI-compatible chat completion messages. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: OpenAIChatCompletionContentPartTextParam + type: object + OpenAIFile: + properties: + type: + const: file + default: file + title: Type + type: string + file: + $ref: '#/components/schemas/OpenAIFileFile' + required: + - file + title: OpenAIFile + type: object + OpenAIFileFile: + properties: + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIFileFile + type: object + OpenAIImageURL: + description: Image URL specification for OpenAI-compatible chat completion messages. + properties: + url: + title: Url + type: string + detail: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - url + title: OpenAIImageURL + type: object OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -8960,6 +2453,122 @@ components: nullable: true title: OpenAIAssistantMessageParam type: object + OpenAIChatCompletionToolCall: + description: Tool call specification for OpenAI-compatible chat completion responses. + properties: + index: + anyOf: + - type: integer + - type: 'null' + nullable: true + id: + anyOf: + - type: string + - type: 'null' + nullable: true + type: + const: function + default: function + title: Type + type: string + function: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' + title: OpenAIChatCompletionToolCallFunction + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + title: OpenAIChatCompletionToolCall + type: object + OpenAIChatCompletionToolCallFunction: + description: Function call details for OpenAI-compatible tool calls. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + arguments: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + type: object + OpenAIDeveloperMessageParam: + description: A message from the developer in an OpenAI-compatible chat completion request. + properties: + role: + const: developer + default: developer + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAIDeveloperMessageParam + type: object + OpenAISystemMessageParam: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAISystemMessageParam + type: object + OpenAIToolMessageParam: + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. + properties: + role: + const: tool + default: tool + title: Role + type: string + tool_call_id: + title: Tool Call Id + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + required: + - tool_call_id + - content + title: OpenAIToolMessageParam + type: object OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -9019,6 +2628,61 @@ components: - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) + OpenAIJSONSchema: + description: JSON schema specification for OpenAI-compatible structured response format. + properties: + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + title: OpenAIJSONSchema + type: object + OpenAIResponseFormatJSONObject: + description: JSON object response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_object + default: json_object + title: Type + type: string + title: OpenAIResponseFormatJSONObject + type: object + OpenAIResponseFormatJSONSchema: + description: JSON schema response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_schema + default: json_schema + title: Type + type: string + json_schema: + $ref: '#/components/schemas/OpenAIJSONSchema' + required: + - json_schema + title: OpenAIResponseFormatJSONSchema + type: object + OpenAIResponseFormatText: + description: Text response format for OpenAI-compatible chat completion requests. + properties: + type: + const: text + default: text + title: Type + type: string + title: OpenAIResponseFormatText + type: object OpenAIResponseFormatParam: discriminator: mapping: @@ -9034,6 +2698,45 @@ components: - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + VectorStoreChunkingStrategyAuto: + description: Automatic chunking strategy for vector store files. + properties: + type: + const: auto + default: auto + title: Type + type: string + title: VectorStoreChunkingStrategyAuto + type: object + VectorStoreChunkingStrategyStatic: + description: Static chunking strategy with configurable parameters. + properties: + type: + const: static + default: static + title: Type + type: string + static: + $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + required: + - static + title: VectorStoreChunkingStrategyStatic + type: object + VectorStoreChunkingStrategyStaticConfig: + description: Configuration for static chunking strategy. + properties: + chunk_overlap_tokens: + default: 400 + title: Chunk Overlap Tokens + type: integer + max_chunk_size_tokens: + default: 800 + maximum: 4096 + minimum: 100 + title: Max Chunk Size Tokens + type: integer + title: VectorStoreChunkingStrategyStaticConfig + type: object VectorStoreChunkingStrategy: discriminator: mapping: @@ -9054,6 +2757,79 @@ components: - cancelled - failed default: completed + OpenAIResponseInputMessageContentFile: + description: File content for input messages in OpenAI response format. + properties: + type: + const: input_file + default: input_file + title: Type + type: string + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + file_url: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentFile + type: object + OpenAIResponseInputMessageContentImage: + description: Image content for input messages in OpenAI response format. + properties: + detail: + default: auto + title: Detail + type: string + enum: + - low + - high + - auto + type: + const: input_image + default: input_image + title: Type + type: string + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + image_url: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentImage + type: object + OpenAIResponseInputMessageContentText: + description: Text content for input messages in OpenAI response format. + properties: + text: + title: Text + type: string + type: + const: input_text + default: input_text + title: Type + type: string + required: + - text + title: OpenAIResponseInputMessageContentText + type: object OpenAIResponseInputMessageContent: discriminator: mapping: @@ -9069,6 +2845,104 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + OpenAIResponseAnnotationCitation: + description: URL citation annotation for referencing external web resources. + properties: + type: + const: url_citation + default: url_citation + title: Type + type: string + end_index: + title: End Index + type: integer + start_index: + title: Start Index + type: integer + title: + title: Title + type: string + url: + title: Url + type: string + required: + - end_index + - start_index + - title + - url + title: OpenAIResponseAnnotationCitation + type: object + OpenAIResponseAnnotationContainerFileCitation: + properties: + type: + const: container_file_citation + default: container_file_citation + title: Type + type: string + container_id: + title: Container Id + type: string + end_index: + title: End Index + type: integer + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + start_index: + title: Start Index + type: integer + required: + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation + type: object + OpenAIResponseAnnotationFileCitation: + description: File citation annotation for referencing specific files in response content. + properties: + type: + const: file_citation + default: file_citation + title: Type + type: string + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + index: + title: Index + type: integer + required: + - file_id + - filename + - index + title: OpenAIResponseAnnotationFileCitation + type: object + OpenAIResponseAnnotationFilePath: + properties: + type: + const: file_path + default: file_path + title: Type + type: string + file_id: + title: File Id + type: string + index: + title: Index + type: integer + required: + - file_id + - index + title: OpenAIResponseAnnotationFilePath + type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -9087,6 +2961,56 @@ components: - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + OpenAIResponseContentPartRefusal: + description: Refusal content within a streamed response part. + properties: + type: + const: refusal + default: refusal + title: Type + type: string + refusal: + title: Refusal + type: string + required: + - refusal + title: OpenAIResponseContentPartRefusal + type: object + OpenAIResponseOutputMessageContentOutputText: + properties: + text: + title: Text + type: string + type: + const: output_text + default: output_text + title: Type + type: string + annotations: + items: + discriminator: + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + title: OpenAIResponseAnnotationFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + title: OpenAIResponseAnnotationCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + title: OpenAIResponseAnnotationContainerFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + title: OpenAIResponseAnnotationFilePath + title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + title: Annotations + type: array + required: + - text + title: OpenAIResponseOutputMessageContentOutputText + type: object OpenAIResponseOutputMessageContent: discriminator: mapping: @@ -9099,6 +3023,53 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal + MCPListToolsTool: + description: Tool definition returned by MCP list tools operation. + properties: + input_schema: + additionalProperties: true + title: Input Schema + type: object + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - input_schema + - name + title: MCPListToolsTool + type: object + OpenAIResponseMCPApprovalRequest: + description: A request for human approval of a tool invocation. + properties: + arguments: + title: Arguments + type: string + id: + title: Id + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + type: + const: mcp_approval_request + default: mcp_approval_request + title: Type + type: string + required: + - arguments + - id + - name + - server_label + title: OpenAIResponseMCPApprovalRequest + type: object OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -9170,6 +3141,179 @@ components: - role title: OpenAIResponseMessage type: object + OpenAIResponseOutputMessageFileSearchToolCall: + description: File search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + queries: + items: + type: string + title: Queries + type: array + status: + title: Status + type: string + type: + const: file_search_call + default: file_search_call + title: Type + type: string + results: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' + type: array + - type: 'null' + nullable: true + required: + - id + - queries + - status + title: OpenAIResponseOutputMessageFileSearchToolCall + type: object + OpenAIResponseOutputMessageFileSearchToolCallResults: + description: Search results returned by the file search operation. + properties: + attributes: + additionalProperties: true + title: Attributes + type: object + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + score: + title: Score + type: number + text: + title: Text + type: string + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + type: object + OpenAIResponseOutputMessageFunctionToolCall: + description: Function tool call output message for OpenAI responses. + properties: + call_id: + title: Call Id + type: string + name: + title: Name + type: string + arguments: + title: Arguments + type: string + type: + const: function_call + default: function_call + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - name + - arguments + title: OpenAIResponseOutputMessageFunctionToolCall + type: object + OpenAIResponseOutputMessageMCPCall: + description: Model Context Protocol (MCP) call output message for OpenAI responses. + properties: + id: + title: Id + type: string + type: + const: mcp_call + default: mcp_call + title: Type + type: string + arguments: + title: Arguments + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + error: + anyOf: + - type: string + - type: 'null' + nullable: true + output: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + - arguments + - name + - server_label + title: OpenAIResponseOutputMessageMCPCall + type: object + OpenAIResponseOutputMessageMCPListTools: + description: MCP list tools output message containing available tools from an MCP server. + properties: + id: + title: Id + type: string + type: + const: mcp_list_tools + default: mcp_list_tools + title: Type + type: string + server_label: + title: Server Label + type: string + tools: + items: + $ref: '#/components/schemas/MCPListToolsTool' + title: Tools + type: array + required: + - id + - server_label + - tools + title: OpenAIResponseOutputMessageMCPListTools + type: object + OpenAIResponseOutputMessageWebSearchToolCall: + description: Web search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + status: + title: Status + type: string + type: + const: web_search_call + default: web_search_call + title: Type + type: string + required: + - id + - status + title: OpenAIResponseOutputMessageWebSearchToolCall + type: object OpenAIResponseOutput: discriminator: mapping: @@ -9197,6 +3341,186 @@ components: - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) + AllowedToolsFilter: + description: Filter configuration for restricting which MCP tools can be used. + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: AllowedToolsFilter + type: object + ApprovalFilter: + description: Filter configuration for MCP tool approval requirements. + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: ApprovalFilter + type: object + OpenAIResponseInputToolFileSearch: + description: File search tool configuration for OpenAI response inputs. + properties: + type: + const: file_search + default: file_search + title: Type + type: string + vector_store_ids: + items: + type: string + title: Vector Store Ids + type: array + filters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + max_num_results: + anyOf: + - maximum: 50 + minimum: 1 + type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + nullable: true + title: SearchRankingOptions + required: + - vector_store_ids + title: OpenAIResponseInputToolFileSearch + type: object + OpenAIResponseInputToolFunction: + description: Function tool configuration for OpenAI response inputs. + properties: + type: + const: function + default: function + title: Type + type: string + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + parameters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + nullable: true + required: + - name + - parameters + title: OpenAIResponseInputToolFunction + type: object + OpenAIResponseInputToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + server_url: + title: Server Url + type: string + headers: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + require_approval: + anyOf: + - const: always + type: string + - const: never + type: string + - $ref: '#/components/schemas/ApprovalFilter' + title: ApprovalFilter + default: never + title: string | ApprovalFilter + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + - server_url + title: OpenAIResponseInputToolMCP + type: object + OpenAIResponseInputToolWebSearch: + description: Web search tool configuration for OpenAI response inputs. + properties: + type: + default: web_search + title: Type + type: string + enum: + - web_search + - web_search_preview + - web_search_preview_2025_03_11 + - web_search_2025_08_26 + search_context_size: + anyOf: + - pattern: ^low|medium|high$ + type: string + - type: 'null' + default: medium + title: OpenAIResponseInputToolWebSearch + type: object + SearchRankingOptions: + description: Options for ranking and filtering search results. + properties: + ranker: + anyOf: + - type: string + - type: 'null' + nullable: true + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + title: SearchRankingOptions + type: object OpenAIResponseInputTool: discriminator: mapping: @@ -9218,6 +3542,32 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) + OpenAIResponseToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + title: OpenAIResponseToolMCP + type: object OpenAIResponseTool: discriminator: mapping: @@ -9328,6 +3678,164 @@ components: - text title: OpenAIResponseContentPartReasoningSummary type: object + OpenAIResponseError: + description: Error details for failed OpenAI response requests. + properties: + code: + title: Code + type: string + message: + title: Message + type: string + required: + - code + - message + title: OpenAIResponseError + type: object + OpenAIResponseObject: + description: Complete OpenAI response object containing generation results and metadata. + properties: + created_at: + title: Created At + type: integer + error: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseError' + title: OpenAIResponseError + - type: 'null' + nullable: true + title: OpenAIResponseError + id: + title: Id + type: string + model: + title: Model + type: string + object: + const: response + default: response + title: Object + type: string + output: + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + title: Output + type: array + parallel_tool_calls: + default: false + title: Parallel Tool Calls + type: boolean + previous_response_id: + anyOf: + - type: string + - type: 'null' + nullable: true + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + nullable: true + title: OpenAIResponsePrompt + status: + title: Status + type: string + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + text: + $ref: '#/components/schemas/OpenAIResponseText' + default: + format: + type: text + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + tools: + anyOf: + - items: + discriminator: + mapping: + file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' + function: '#/components/schemas/OpenAIResponseInputToolFunction' + mcp: '#/components/schemas/OpenAIResponseToolMCP' + web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + title: OpenAIResponseInputToolWebSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + title: OpenAIResponseInputToolFileSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + title: OpenAIResponseInputToolFunction + - $ref: '#/components/schemas/OpenAIResponseToolMCP' + title: OpenAIResponseToolMCP + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + nullable: true + truncation: + anyOf: + - type: string + - type: 'null' + nullable: true + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsage' + title: OpenAIResponseUsage + - type: 'null' + nullable: true + title: OpenAIResponseUsage + instructions: + anyOf: + - type: string + - type: 'null' + nullable: true + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + nullable: true + required: + - created_at + - id + - model + - output + - status + title: OpenAIResponseObject + type: object OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: @@ -10302,6 +4810,135 @@ components: - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object + OpenAIResponsePrompt: + description: OpenAI compatible Prompt object that is used in OpenAI responses. + properties: + id: + title: Id + type: string + variables: + anyOf: + - additionalProperties: + discriminator: + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: object + - type: 'null' + nullable: true + version: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + title: OpenAIResponsePrompt + type: object + OpenAIResponseText: + description: Text response configuration for OpenAI responses. + properties: + format: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseTextFormat' + title: OpenAIResponseTextFormat + - type: 'null' + nullable: true + title: OpenAIResponseTextFormat + title: OpenAIResponseText + type: object + OpenAIResponseTextFormat: + description: Configuration for Responses API text format. + properties: + type: + title: Type + type: string + enum: + - text + - json_schema + - json_object + default: text + name: + anyOf: + - type: string + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + title: OpenAIResponseTextFormat + type: object + OpenAIResponseUsage: + description: Usage information for OpenAI response. + properties: + input_tokens: + title: Input Tokens + type: integer + output_tokens: + title: Output Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + input_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' + title: OpenAIResponseUsageInputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + output_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' + title: OpenAIResponseUsageOutputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + required: + - input_tokens + - output_tokens + - total_tokens + title: OpenAIResponseUsage + type: object + OpenAIResponseUsageInputTokensDetails: + description: Token details for input tokens in OpenAI response usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + type: object + OpenAIResponseUsageOutputTokensDetails: + description: Token details for output tokens in OpenAI response usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + type: object OpenAIResponseObjectStream: discriminator: mapping: @@ -10416,6 +5053,64 @@ components: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) + OpenAIResponseInputFunctionToolCallOutput: + description: This represents the output of a function call that gets passed back to the model. + properties: + call_id: + title: Call Id + type: string + output: + title: Output + type: string + type: + const: function_call_output + default: function_call_output + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - output + title: OpenAIResponseInputFunctionToolCallOutput + type: object + OpenAIResponseMCPApprovalResponse: + description: A response to an MCP approval request. + properties: + approval_request_id: + title: Approval Request Id + type: string + approve: + title: Approve + type: boolean + type: + const: mcp_approval_response + default: mcp_approval_response + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + reason: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - approval_request_id + - approve + title: OpenAIResponseMCPApprovalResponse + type: object OpenAIResponseInput: anyOf: - discriminator: @@ -10451,51 +5146,96 @@ components: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage - ConversationItem: - discriminator: - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - propertyName: type - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - title: OpenAIResponseMessage - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - DataSource: - discriminator: - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - propertyName: type - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource + ArrayType: + description: Parameter type for array values. + properties: + type: + const: array + default: array + title: Type + type: string + title: ArrayType + type: object + BooleanType: + description: Parameter type for boolean values. + properties: + type: + const: boolean + default: boolean + title: Type + type: string + title: BooleanType + type: object + ChatCompletionInputType: + description: Parameter type for chat completion input. + properties: + type: + const: chat_completion_input + default: chat_completion_input + title: Type + type: string + title: ChatCompletionInputType + type: object + CompletionInputType: + description: Parameter type for completion input. + properties: + type: + const: completion_input + default: completion_input + title: Type + type: string + title: CompletionInputType + type: object + JsonType: + description: Parameter type for JSON values. + properties: + type: + const: json + default: json + title: Type + type: string + title: JsonType + type: object + NumberType: + description: Parameter type for numeric values. + properties: + type: + const: number + default: number + title: Type + type: string + title: NumberType + type: object + ObjectType: + description: Parameter type for object values. + properties: + type: + const: object + default: object + title: Type + type: string + title: ObjectType + type: object + StringType: + description: Parameter type for string values. + properties: + type: + const: string + default: string + title: Type + type: string + title: StringType + type: object + UnionType: + description: Parameter type for union values. + properties: + type: + const: union + default: union + title: Type + type: string + title: UnionType + type: object ParamType: discriminator: mapping: @@ -10529,6 +5269,164 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + ConversationItem: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + RowsDataSource: + description: A dataset stored in rows. + properties: + type: + const: rows + default: rows + title: Type + type: string + rows: + items: + additionalProperties: true + type: object + title: Rows + type: array + required: + - rows + title: RowsDataSource + type: object + URIDataSource: + description: A dataset that can be obtained from a URI. + properties: + type: + const: uri + default: uri + title: Type + type: string + uri: + title: Uri + type: string + required: + - uri + title: URIDataSource + type: object + DataSource: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + AggregationFunctionType: + description: Types of aggregation functions for scoring results. + enum: + - average + - weighted_average + - median + - categorical_count + - accuracy + title: AggregationFunctionType + type: string + BasicScoringFnParams: + description: Parameters for basic scoring function configuration. + properties: + type: + const: basic + default: basic + title: Type + type: string + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: BasicScoringFnParams + type: object + LLMAsJudgeScoringFnParams: + description: Parameters for LLM-as-judge scoring function configuration. + properties: + type: + const: llm_as_judge + default: llm_as_judge + title: Type + type: string + judge_model: + title: Judge Model + type: string + prompt_template: + anyOf: + - type: string + - type: 'null' + nullable: true + judge_score_regexes: + description: Regexes to extract the answer from generated response + items: + type: string + title: Judge Score Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + required: + - judge_model + title: LLMAsJudgeScoringFnParams + type: object + RegexParserScoringFnParams: + description: Parameters for regex parser scoring function configuration. + properties: + type: + const: regex_parser + default: regex_parser + title: Type + type: string + parsing_regexes: + description: Regex to extract the answer from generated response + items: + type: string + title: Parsing Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: RegexParserScoringFnParams + type: object ScoringFnParams: discriminator: mapping: @@ -10544,6 +5442,68 @@ components: - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + LoraFinetuningConfig: + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. + properties: + type: + const: LoRA + default: LoRA + title: Type + type: string + lora_attn_modules: + items: + type: string + title: Lora Attn Modules + type: array + apply_lora_to_mlp: + title: Apply Lora To Mlp + type: boolean + apply_lora_to_output: + title: Apply Lora To Output + type: boolean + rank: + title: Rank + type: integer + alpha: + title: Alpha + type: integer + use_dora: + anyOf: + - type: boolean + - type: 'null' + default: false + quantize_base: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + title: LoraFinetuningConfig + type: object + QATFinetuningConfig: + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. + properties: + type: + const: QAT + default: QAT + title: Type + type: string + quantizer_name: + title: Quantizer Name + type: string + group_size: + title: Group Size + type: integer + required: + - quantizer_name + - group_size + title: QATFinetuningConfig + type: object AlgorithmConfig: discriminator: mapping: @@ -10777,15 +5737,55 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - ResponseGuardrailSpec: - description: Specification for a guardrail to apply during response generation. + ListOpenAIResponseInputItem: + description: List container for OpenAI response input items. properties: - type: - title: Type + data: + items: + anyOf: + - discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage + title: Data + type: array + object: + const: list + default: list + title: Object type: string required: - - type - title: ResponseGuardrailSpec + - data + title: ListOpenAIResponseInputItem type: object OpenAIResponseObjectWithInput: description: OpenAI response object extended with input context information. @@ -10970,6 +5970,426 @@ components: - input title: OpenAIResponseObjectWithInput type: object + ListOpenAIResponseObject: + description: Paginated list of OpenAI response objects with navigation metadata. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIResponseObjectWithInput' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIResponseObject + type: object + OpenAIDeleteResponseObject: + description: Response object confirming deletion of an OpenAI response. + properties: + id: + title: Id + type: string + object: + const: response + default: response + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: OpenAIDeleteResponseObject + type: object + ResponseGuardrailSpec: + description: Specification for a guardrail to apply during response generation. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + Batch: + additionalProperties: true + properties: + id: + title: Id + type: string + completion_window: + title: Completion Window + type: string + created_at: + title: Created At + type: integer + endpoint: + title: Endpoint + type: string + input_file_id: + title: Input File Id + type: string + object: + const: batch + title: Object + type: string + status: + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + title: Status + type: string + cancelled_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + cancelling_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + completed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + error_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + errors: + anyOf: + - $ref: '#/components/schemas/Errors' + title: Errors + - type: 'null' + nullable: true + title: Errors + expired_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + failed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + finalizing_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + in_progress_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + nullable: true + model: + anyOf: + - type: string + - type: 'null' + nullable: true + output_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + request_counts: + anyOf: + - $ref: '#/components/schemas/BatchRequestCounts' + title: BatchRequestCounts + - type: 'null' + nullable: true + title: BatchRequestCounts + usage: + anyOf: + - $ref: '#/components/schemas/BatchUsage' + title: BatchUsage + - type: 'null' + nullable: true + title: BatchUsage + required: + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status + title: Batch + type: object + BatchError: + additionalProperties: true + properties: + code: + anyOf: + - type: string + - type: 'null' + nullable: true + line: + anyOf: + - type: integer + - type: 'null' + nullable: true + message: + anyOf: + - type: string + - type: 'null' + nullable: true + param: + anyOf: + - type: string + - type: 'null' + nullable: true + title: BatchError + type: object + BatchRequestCounts: + additionalProperties: true + properties: + completed: + title: Completed + type: integer + failed: + title: Failed + type: integer + total: + title: Total + type: integer + required: + - completed + - failed + - total + title: BatchRequestCounts + type: object + BatchUsage: + additionalProperties: true + properties: + input_tokens: + title: Input Tokens + type: integer + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + title: Output Tokens + type: integer + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + title: Total Tokens + type: integer + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + type: object + Errors: + additionalProperties: true + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + nullable: true + object: + anyOf: + - type: string + - type: 'null' + nullable: true + title: Errors + type: object + InputTokensDetails: + additionalProperties: true + properties: + cached_tokens: + title: Cached Tokens + type: integer + required: + - cached_tokens + title: InputTokensDetails + type: object + OutputTokensDetails: + additionalProperties: true + properties: + reasoning_tokens: + title: Reasoning Tokens + type: integer + required: + - reasoning_tokens + title: OutputTokensDetails + type: object + ListBatchesResponse: + description: Response containing a list of batch objects. + properties: + object: + const: list + default: list + title: Object + type: string + data: + description: List of batch objects + items: + $ref: '#/components/schemas/Batch' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: ID of the first batch in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: ID of the last batch in the list + nullable: true + has_more: + default: false + description: Whether there are more batches available + title: Has More + type: boolean + required: + - data + title: ListBatchesResponse + type: object + Benchmark: + description: A benchmark resource for evaluating model performance. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: benchmark + default: benchmark + title: Type + type: string + dataset_id: + title: Dataset Id + type: string + scoring_functions: + items: + type: string + title: Scoring Functions + type: array + metadata: + additionalProperties: true + description: Metadata for this evaluation task + title: Metadata + type: object + required: + - identifier + - provider_id + - dataset_id + - scoring_functions + title: Benchmark + type: object + ImageDelta: + description: An image content delta for streaming responses. + properties: + type: + const: image + default: image + title: Type + type: string + image: + format: binary + title: Image + type: string + required: + - image + title: ImageDelta + type: object + TextDelta: + description: A text content delta for streaming responses. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextDelta + type: object + JobStatus: + description: Status of a job execution. + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + type: string + Job: + description: A job execution instance with status tracking. + properties: + job_id: + title: Job Id + type: string + status: + $ref: '#/components/schemas/JobStatus' + required: + - job_id + - status + title: Job + type: object MetricInResponse: description: A metric value included in API responses. properties: @@ -10991,6 +6411,84 @@ components: - value title: MetricInResponse type: object + PaginatedResponse: + description: A generic paginated response that follows a simple format. + properties: + data: + items: + additionalProperties: true + type: object + title: Data + type: array + has_more: + title: Has More + type: boolean + url: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + - has_more + title: PaginatedResponse + type: object + PostTrainingMetric: + description: Training metrics captured during post-training jobs. + properties: + epoch: + title: Epoch + type: integer + train_loss: + title: Train Loss + type: number + validation_loss: + title: Validation Loss + type: number + perplexity: + title: Perplexity + type: number + required: + - epoch + - train_loss + - validation_loss + - perplexity + title: PostTrainingMetric + type: object + Checkpoint: + description: Checkpoint created during training runs. + properties: + identifier: + title: Identifier + type: string + created_at: + format: date-time + title: Created At + type: string + epoch: + title: Epoch + type: integer + post_training_job_id: + title: Post Training Job Id + type: string + path: + title: Path + type: string + training_metrics: + anyOf: + - $ref: '#/components/schemas/PostTrainingMetric' + title: PostTrainingMetric + - type: 'null' + nullable: true + title: PostTrainingMetric + required: + - identifier + - created_at + - epoch + - post_training_job_id + - path + title: Checkpoint + type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: @@ -11001,6 +6499,66 @@ components: type: string title: DialogType type: object + Conversation: + description: OpenAI-compatible conversation object. + properties: + id: + description: The unique ID of the conversation. + title: Id + type: string + object: + const: conversation + default: conversation + description: The object type, which is always conversation. + title: Object + type: string + created_at: + description: The time at which the conversation was created, measured in seconds since the Unix epoch. + title: Created At + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. + nullable: true + items: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + description: Initial items to include in the conversation context. You may add up to 20 items at a time. + nullable: true + required: + - id + - created_at + title: Conversation + type: object + ConversationDeletedResource: + description: Response for deleted conversation. + properties: + id: + description: The deleted conversation identifier + title: Id + type: string + object: + default: conversation.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationDeletedResource + type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: @@ -11046,6 +6604,93 @@ components: - items title: ConversationItemCreateRequest type: object + ConversationItemDeletedResource: + description: Response for deleted conversation item. + properties: + id: + description: The deleted item identifier + title: Id + type: string + object: + default: conversation.item.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationItemDeletedResource + type: object + ConversationItemList: + description: List of conversation items with pagination. + properties: + object: + default: list + description: Object type + title: Object + type: string + data: + description: List of conversation items + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the first item in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the last item in the list + nullable: true + has_more: + default: false + description: Whether there are more items available + title: Has More + type: boolean + required: + - data + title: ConversationItemList + type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: @@ -11085,6 +6730,857 @@ components: - status title: ConversationMessage type: object + DatasetPurpose: + description: Purpose of the dataset. Each purpose has a required input data schema. + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + type: string + Dataset: + description: Dataset resource for storing and accessing training or evaluation data. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: dataset + default: dataset + title: Type + type: string + purpose: + $ref: '#/components/schemas/DatasetPurpose' + source: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + metadata: + additionalProperties: true + description: Any additional metadata for this dataset + title: Metadata + type: object + required: + - identifier + - provider_id + - purpose + - source + title: Dataset + type: object + Error: + description: Error response from the API. Roughly follows RFC 7807. + properties: + status: + title: Status + type: integer + title: + title: Title + type: string + detail: + title: Detail + type: string + instance: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - status + - title + - detail + title: Error + type: object + Api: + description: Enumeration of all available APIs in the Llama Stack system. + enum: + - providers + - inference + - safety + - agents + - batches + - vector_io + - datasetio + - scoring + - eval + - post_training + - tool_runtime + - models + - shields + - vector_stores + - datasets + - scoring_functions + - benchmarks + - tool_groups + - files + - prompts + - conversations + - inspect + title: Api + type: string + InlineProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + container_image: + anyOf: + - type: string + - type: 'null' + description: |2 + + The container image to use for this implementation. If one is provided, pip_packages will be ignored. + If a provider depends on other providers, the dependencies MUST NOT specify a container image. + nullable: true + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + title: InlineProviderSpec + type: object + ModelType: + description: Enumeration of supported model types in Llama Stack. + enum: + - llm + - embedding + - rerank + title: ModelType + type: string + Model: + description: A model resource representing an AI model registered in Llama Stack. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: model + default: model + title: Type + type: string + metadata: + additionalProperties: true + description: Any additional metadata for this model + title: Metadata + type: object + model_type: + $ref: '#/components/schemas/ModelType' + default: llm + required: + - identifier + - provider_id + title: Model + type: object + ProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + required: + - api + - provider_type + - config_class + title: ProviderSpec + type: object + RemoteProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + adapter_type: + description: Unique identifier for this adapter + title: Adapter Type + type: string + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + - adapter_type + title: RemoteProviderSpec + type: object + ScoringFn: + description: A scoring function resource for evaluating model outputs. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: scoring_function + default: scoring_function + title: Type + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + description: Any additional metadata for this definition + title: Metadata + type: object + return_type: + description: The return type of the deterministic function + discriminator: + mapping: + array: '#/components/schemas/ArrayType' + boolean: '#/components/schemas/BooleanType' + chat_completion_input: '#/components/schemas/ChatCompletionInputType' + completion_input: '#/components/schemas/CompletionInputType' + json: '#/components/schemas/JsonType' + number: '#/components/schemas/NumberType' + object: '#/components/schemas/ObjectType' + string: '#/components/schemas/StringType' + union: '#/components/schemas/UnionType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/StringType' + title: StringType + - $ref: '#/components/schemas/NumberType' + title: NumberType + - $ref: '#/components/schemas/BooleanType' + title: BooleanType + - $ref: '#/components/schemas/ArrayType' + title: ArrayType + - $ref: '#/components/schemas/ObjectType' + title: ObjectType + - $ref: '#/components/schemas/JsonType' + title: JsonType + - $ref: '#/components/schemas/UnionType' + title: UnionType + - $ref: '#/components/schemas/ChatCompletionInputType' + title: ChatCompletionInputType + - $ref: '#/components/schemas/CompletionInputType' + title: CompletionInputType + title: StringType | ... (9 variants) + params: + anyOf: + - discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + title: Params + nullable: true + required: + - identifier + - provider_id + - return_type + title: ScoringFn + type: object + Shield: + description: A safety shield resource that can be used to check content. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: shield + default: shield + title: Type + type: string + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: Shield + type: object + ToolGroup: + description: A group of related tools managed together. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: tool_group + default: tool_group + title: Type + type: string + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: ToolGroup + type: object + ModelCandidate: + description: A model candidate for evaluation. + properties: + type: + const: model + default: model + title: Type + type: string + model: + title: Model + type: string + sampling_params: + $ref: '#/components/schemas/SamplingParams' + system_message: + anyOf: + - $ref: '#/components/schemas/SystemMessage' + title: SystemMessage + - type: 'null' + nullable: true + title: SystemMessage + required: + - model + - sampling_params + title: ModelCandidate + type: object + SamplingParams: + description: Sampling parameters. + properties: + strategy: + discriminator: + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreedySamplingStrategy' + title: GreedySamplingStrategy + - $ref: '#/components/schemas/TopPSamplingStrategy' + title: TopPSamplingStrategy + - $ref: '#/components/schemas/TopKSamplingStrategy' + title: TopKSamplingStrategy + title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + repetition_penalty: + anyOf: + - type: number + - type: 'null' + default: 1.0 + stop: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: SamplingParams + type: object + SystemMessage: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + title: string | list[ImageContentItem | TextContentItem] + required: + - content + title: SystemMessage + type: object + BenchmarkConfig: + description: A benchmark configuration for evaluation. + properties: + eval_candidate: + $ref: '#/components/schemas/ModelCandidate' + scoring_params: + additionalProperties: + discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + description: Map between scoring function id and parameters for each scoring function you want to run + title: Scoring Params + type: object + num_examples: + anyOf: + - type: integer + - type: 'null' + description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated + nullable: true + required: + - eval_candidate + title: BenchmarkConfig + type: object + ScoringResult: + description: A scoring result for a single row. + properties: + score_rows: + items: + additionalProperties: true + type: object + title: Score Rows + type: array + aggregated_results: + additionalProperties: true + title: Aggregated Results + type: object + required: + - score_rows + - aggregated_results + title: ScoringResult + type: object + EvaluateResponse: + description: The response from an evaluation. + properties: + generations: + items: + additionalProperties: true + type: object + title: Generations + type: array + scores: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Scores + type: object + required: + - generations + - scores + title: EvaluateResponse + type: object + ExpiresAfter: + description: |- + Control expiration of uploaded files. + + Params: + - anchor, must be "created_at" + - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) + properties: + anchor: + const: created_at + title: Anchor + type: string + seconds: + maximum: 2592000 + minimum: 3600 + title: Seconds + type: integer + required: + - anchor + - seconds + title: ExpiresAfter + type: object + OpenAIFileObject: + description: OpenAI File object as defined in the OpenAI Files API. + properties: + object: + const: file + default: file + title: Object + type: string + id: + title: Id + type: string + bytes: + title: Bytes + type: integer + created_at: + title: Created At + type: integer + expires_at: + title: Expires At + type: integer + filename: + title: Filename + type: string + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + required: + - id + - bytes + - created_at + - expires_at + - filename + - purpose + title: OpenAIFileObject + type: object + OpenAIFilePurpose: + description: Valid purpose values for OpenAI Files API. + enum: + - assistants + - batch + title: OpenAIFilePurpose + type: string + ListOpenAIFileResponse: + description: Response for listing files in OpenAI Files API. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIFileObject' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIFileResponse + type: object + OpenAIFileDeleteResponse: + description: Response for deleting a file in OpenAI Files API. + properties: + id: + title: Id + type: string + object: + const: file + default: file + title: Object + type: string + deleted: + title: Deleted + type: boolean + required: + - id + - deleted + title: OpenAIFileDeleteResponse + type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: @@ -11134,6 +7630,304 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig type: object + OpenAIChatCompletionUsage: + description: Usage information for OpenAI chat completion. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + completion_tokens: + title: Completion Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + prompt_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' + title: OpenAIChatCompletionUsagePromptTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + completion_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' + title: OpenAIChatCompletionUsageCompletionTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + required: + - prompt_tokens + - completion_tokens + - total_tokens + title: OpenAIChatCompletionUsage + type: object + OpenAIChatCompletionUsageCompletionTokensDetails: + description: Token details for output tokens in OpenAI chat completion usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + type: object + OpenAIChatCompletionUsagePromptTokensDetails: + description: Token details for prompt tokens in OpenAI chat completion usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + type: object + OpenAIChoice: + description: A choice from an OpenAI-compatible chat completion response. + properties: + message: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + finish_reason: + title: Finish Reason + type: string + index: + title: Index + type: integer + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + required: + - message + - finish_reason + - index + title: OpenAIChoice + type: object + OpenAIChoiceLogprobs: + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. + properties: + content: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + refusal: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + type: object + OpenAICompletionWithInputMessages: + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + input_messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + title: Input Messages + type: array + required: + - id + - choices + - created + - model + - input_messages + title: OpenAICompletionWithInputMessages + type: object + OpenAITokenLogProb: + description: |- + The log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + :top_logprobs: The top log probabilities for the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + title: Top Logprobs + type: array + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb + type: object + OpenAITopLogProb: + description: |- + The top log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + required: + - token + - logprob + title: OpenAITopLogProb + type: object + ListOpenAIChatCompletionResponse: + description: Response from listing OpenAI-compatible chat completions. + properties: + data: + items: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIChatCompletionResponse + type: object + OpenAIChatCompletion: + description: Response from an OpenAI-compatible chat completion request. + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + required: + - id + - choices + - created + - model + title: OpenAIChatCompletion + type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: @@ -11166,25 +7960,6 @@ components: nullable: true title: OpenAIChoiceDelta type: object - OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - title: OpenAIChoiceLogprobs - type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: @@ -11245,48 +8020,181 @@ components: - model title: OpenAIChatCompletionChunk type: object - OpenAIChoice: - description: A choice from an OpenAI-compatible chat completion response. + OpenAIChatCompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible chat completion endpoint. properties: - message: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - finish_reason: - title: Finish Reason + model: + title: Model type: string - index: - title: Index - type: integer - logprobs: + messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + minItems: 1 + title: Messages + type: array + frequency_penalty: anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs' - title: OpenAIChoiceLogprobs + - type: number + - type: 'null' + nullable: true + function_call: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + functions: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_completion_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + response_format: + anyOf: + - discriminator: + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseFormatText' + title: OpenAIResponseFormatText + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + title: OpenAIResponseFormatJSONSchema + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + title: OpenAIResponseFormatJSONObject + title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + - type: 'null' + title: Response Format + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + tool_choice: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + tools: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + top_logprobs: + anyOf: + - type: integer + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string - type: 'null' nullable: true - title: OpenAIChoiceLogprobs required: - - message - - finish_reason - - index - title: OpenAIChoice + - model + - messages + title: OpenAIChatCompletionRequestWithExtraBody type: object OpenAICompletionChoice: description: |- @@ -11319,6 +8227,42 @@ components: - index title: OpenAICompletionChoice type: object + OpenAICompletion: + description: |- + Response from an OpenAI-compatible completion request. + + :id: The ID of the completion + :choices: List of choices + :created: The Unix timestamp in seconds when the completion was created + :model: The model that was used to generate the completion + :object: The object type, which will be "text_completion" + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + title: Choices + type: array + created: + title: Created + type: integer + model: + title: Model + type: string + object: + const: text_completion + default: text_completion + title: Object + type: string + required: + - id + - choices + - created + - model + title: OpenAICompletion + type: object OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -11360,6 +8304,247 @@ components: nullable: true title: OpenAICompletionLogprobs type: object + OpenAICompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible completion endpoint. + properties: + model: + title: Model + type: string + prompt: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - items: + type: integer + type: array + title: list[integer] + - items: + items: + type: integer + type: array + type: array + title: list[array] + title: string | ... (4 variants) + best_of: + anyOf: + - type: integer + - type: 'null' + nullable: true + echo: + anyOf: + - type: boolean + - type: 'null' + nullable: true + frequency_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + suffix: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - prompt + title: OpenAICompletionRequestWithExtraBody + type: object + OpenAIEmbeddingData: + description: A single embedding data object from an OpenAI-compatible embeddings response. + properties: + object: + const: embedding + default: embedding + title: Object + type: string + embedding: + anyOf: + - items: + type: number + type: array + title: list[number] + - type: string + title: list[number] | string + index: + title: Index + type: integer + required: + - embedding + - index + title: OpenAIEmbeddingData + type: object + OpenAIEmbeddingUsage: + description: Usage information for an OpenAI-compatible embeddings response. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + required: + - prompt_tokens + - total_tokens + title: OpenAIEmbeddingUsage + type: object + OpenAIEmbeddingsRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible embeddings endpoint. + properties: + model: + title: Model + type: string + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + encoding_format: + anyOf: + - type: string + - type: 'null' + default: float + dimensions: + anyOf: + - type: integer + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - input + title: OpenAIEmbeddingsRequestWithExtraBody + type: object + OpenAIEmbeddingsResponse: + description: Response from an OpenAI-compatible embeddings request. + properties: + object: + const: list + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/OpenAIEmbeddingData' + title: Data + type: array + model: + title: Model + type: string + usage: + $ref: '#/components/schemas/OpenAIEmbeddingUsage' + required: + - data + - model + - usage + title: OpenAIEmbeddingsResponse + type: object + RerankData: + description: A single rerank result from a reranking response. + properties: + index: + title: Index + type: integer + relevance_score: + title: Relevance Score + type: number + required: + - index + - relevance_score + title: RerankData + type: object + RerankResponse: + description: Response from a reranking request. + properties: + data: + items: + $ref: '#/components/schemas/RerankData' + title: Data + type: array + required: + - data + title: RerankResponse + type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: @@ -11489,6 +8674,233 @@ components: - content title: UserMessage type: object + HealthStatus: + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + type: string + HealthInfo: + description: Health status information for the service. + properties: + status: + $ref: '#/components/schemas/HealthStatus' + required: + - status + title: HealthInfo + type: object + RouteInfo: + description: Information about an API route including its path, method, and implementing providers. + properties: + route: + title: Route + type: string + method: + title: Method + type: string + provider_types: + items: + type: string + title: Provider Types + type: array + required: + - route + - method + - provider_types + title: RouteInfo + type: object + ListRoutesResponse: + description: Response containing a list of all available API routes. + properties: + data: + items: + $ref: '#/components/schemas/RouteInfo' + title: Data + type: array + required: + - data + title: ListRoutesResponse + type: object + VersionInfo: + description: Version information for the service. + properties: + version: + title: Version + type: string + required: + - version + title: VersionInfo + type: object + OpenAIModel: + description: |- + A model from OpenAI. + + :id: The ID of the model + :object: The object type, which will be "model" + :created: The Unix timestamp in seconds when the model was created + :owned_by: The owner of the model + :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata + properties: + id: + title: Id + type: string + object: + const: model + default: model + title: Object + type: string + created: + title: Created + type: integer + owned_by: + title: Owned By + type: string + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - id + - created + - owned_by + title: OpenAIModel + type: object + DPOLossType: + enum: + - sigmoid + - hinge + - ipo + - kto_pair + title: DPOLossType + type: string + DPOAlignmentConfig: + description: Configuration for Direct Preference Optimization (DPO) alignment. + properties: + beta: + title: Beta + type: number + loss_type: + $ref: '#/components/schemas/DPOLossType' + default: sigmoid + required: + - beta + title: DPOAlignmentConfig + type: object + DatasetFormat: + description: Format of the training dataset. + enum: + - instruct + - dialog + title: DatasetFormat + type: string + DataConfig: + description: Configuration for training data and data loading. + properties: + dataset_id: + title: Dataset Id + type: string + batch_size: + title: Batch Size + type: integer + shuffle: + title: Shuffle + type: boolean + data_format: + $ref: '#/components/schemas/DatasetFormat' + validation_dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + packed: + anyOf: + - type: boolean + - type: 'null' + default: false + train_on_input: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - dataset_id + - batch_size + - shuffle + - data_format + title: DataConfig + type: object + EfficiencyConfig: + description: Configuration for memory and compute efficiency optimizations. + properties: + enable_activation_checkpointing: + anyOf: + - type: boolean + - type: 'null' + default: false + enable_activation_offloading: + anyOf: + - type: boolean + - type: 'null' + default: false + memory_efficient_fsdp_wrap: + anyOf: + - type: boolean + - type: 'null' + default: false + fsdp_cpu_offload: + anyOf: + - type: boolean + - type: 'null' + default: false + title: EfficiencyConfig + type: object + OptimizerType: + description: Available optimizer algorithms for training. + enum: + - adam + - adamw + - sgd + title: OptimizerType + type: string + OptimizerConfig: + description: Configuration parameters for the optimization algorithm. + properties: + optimizer_type: + $ref: '#/components/schemas/OptimizerType' + lr: + title: Lr + type: number + weight_decay: + title: Weight Decay + type: number + num_warmup_steps: + title: Num Warmup Steps + type: integer + required: + - optimizer_type + - lr + - weight_decay + - num_warmup_steps + title: OptimizerConfig + type: object + PostTrainingJobArtifactsResponse: + description: Artifacts of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + title: PostTrainingJobArtifactsResponse + type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -11505,12 +8917,103 @@ components: - log_lines title: PostTrainingJobLogStream type: object + PostTrainingJobStatusResponse: + description: Status of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + status: + $ref: '#/components/schemas/JobStatus' + scheduled_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + started_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + completed_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + resources_allocated: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + - status + title: PostTrainingJobStatusResponse + type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string + TrainingConfig: + description: Comprehensive configuration for the training process. + properties: + n_epochs: + title: N Epochs + type: integer + max_steps_per_epoch: + default: 1 + title: Max Steps Per Epoch + type: integer + gradient_accumulation_steps: + default: 1 + title: Gradient Accumulation Steps + type: integer + max_validation_steps: + anyOf: + - type: integer + - type: 'null' + default: 1 + data_config: + anyOf: + - $ref: '#/components/schemas/DataConfig' + title: DataConfig + - type: 'null' + nullable: true + title: DataConfig + optimizer_config: + anyOf: + - $ref: '#/components/schemas/OptimizerConfig' + title: OptimizerConfig + - type: 'null' + nullable: true + title: OptimizerConfig + efficiency_config: + anyOf: + - $ref: '#/components/schemas/EfficiencyConfig' + title: EfficiencyConfig + - type: 'null' + nullable: true + title: EfficiencyConfig + dtype: + anyOf: + - type: string + - type: 'null' + default: bf16 + required: + - n_epochs + title: TrainingConfig + type: object PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: @@ -11554,6 +9057,247 @@ components: - logger_config title: PostTrainingRLHFRequest type: object + Prompt: + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. + properties: + prompt: + anyOf: + - type: string + - type: 'null' + description: The system prompt with variable placeholders + nullable: true + version: + description: Version (integer starting at 1, incremented on save) + minimum: 1 + title: Version + type: integer + prompt_id: + description: Unique identifier in format 'pmpt_<48-digit-hash>' + title: Prompt Id + type: string + variables: + description: List of variable names that can be used in the prompt template + items: + type: string + title: Variables + type: array + is_default: + default: false + description: Boolean indicating whether this version is the default version + title: Is Default + type: boolean + required: + - version + - prompt_id + title: Prompt + type: object + ProviderInfo: + description: Information about a registered provider including its configuration and health status. + properties: + api: + title: Api + type: string + provider_id: + title: Provider Id + type: string + provider_type: + title: Provider Type + type: string + config: + additionalProperties: true + title: Config + type: object + health: + additionalProperties: true + title: Health + type: object + required: + - api + - provider_id + - provider_type + - config + - health + title: ProviderInfo + type: object + ModerationObjectResults: + description: A moderation object. + properties: + flagged: + title: Flagged + type: boolean + categories: + anyOf: + - additionalProperties: + type: boolean + type: object + - type: 'null' + nullable: true + category_applied_input_types: + anyOf: + - additionalProperties: + items: + type: string + type: array + type: object + - type: 'null' + nullable: true + category_scores: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - flagged + title: ModerationObjectResults + type: object + ModerationObject: + description: A moderation object. + properties: + id: + title: Id + type: string + model: + title: Model + type: string + results: + items: + $ref: '#/components/schemas/ModerationObjectResults' + title: Results + type: array + required: + - id + - model + - results + title: ModerationObject + type: object + SafetyViolation: + description: Details of a safety violation detected by content moderation. + properties: + violation_level: + $ref: '#/components/schemas/ViolationLevel' + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - violation_level + title: SafetyViolation + type: object + ViolationLevel: + description: Severity level of a safety violation. + enum: + - info + - warn + - error + title: ViolationLevel + type: string + RunShieldResponse: + description: Response from running a safety shield. + properties: + violation: + anyOf: + - $ref: '#/components/schemas/SafetyViolation' + title: SafetyViolation + - type: 'null' + nullable: true + title: SafetyViolation + title: RunShieldResponse + type: object + ScoreBatchResponse: + description: Response from batch scoring operations on datasets. + properties: + dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreBatchResponse + type: object + ScoreResponse: + description: The response from scoring. + properties: + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreResponse + type: object + ToolDef: + description: Tool definition used in runtime contexts. + properties: + toolgroup_id: + anyOf: + - type: string + - type: 'null' + nullable: true + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + input_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + output_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - name + title: ToolDef + type: object + ListToolDefsResponse: + description: Response containing a list of tool definitions. + properties: + data: + items: + $ref: '#/components/schemas/ToolDef' + title: Data + type: array + required: + - data + title: ListToolDefsResponse + type: object ToolGroupInput: description: Input data for registering a tool group. properties: @@ -11581,6 +9325,122 @@ components: - provider_id title: ToolGroupInput type: object + ToolInvocationResult: + description: Result of a tool invocation. + properties: + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + - type: 'null' + title: string | list[ImageContentItem | TextContentItem] + nullable: true + error_message: + anyOf: + - type: string + - type: 'null' + nullable: true + error_code: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: ToolInvocationResult + type: object + ChunkMetadata: + description: |- + `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that + will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` + is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. + Use `Chunk.metadata` for metadata that will be used in the context during inference. + properties: + chunk_id: + anyOf: + - type: string + - type: 'null' + nullable: true + document_id: + anyOf: + - type: string + - type: 'null' + nullable: true + source: + anyOf: + - type: string + - type: 'null' + nullable: true + created_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + updated_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + chunk_window: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_tokenizer: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_model: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_dimension: + anyOf: + - type: integer + - type: 'null' + nullable: true + content_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: ChunkMetadata + type: object Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -11639,6 +9499,140 @@ components: - chunk_id title: Chunk type: object + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store file batch with extra_body support. + properties: + file_ids: + items: + type: string + title: File Ids + type: array + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + required: + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + type: object + OpenAICreateVectorStoreRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store with extra_body support. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + file_ids: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: OpenAICreateVectorStoreRequestWithExtraBody + type: object + QueryChunksResponse: + description: Response from querying chunks in a vector database. + properties: + chunks: + items: + $ref: '#/components/schemas/Chunk' + title: Chunks + type: array + scores: + items: + type: number + title: Scores + type: array + required: + - chunks + - scores + title: QueryChunksResponse + type: object + VectorStoreContent: + description: Content item from a vector store file or search result. + properties: + type: + const: text + title: Type + type: string + text: + title: Text + type: string + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + nullable: true + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + nullable: true + title: ChunkMetadata + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - type + - text + title: VectorStoreContent + type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: @@ -11670,6 +9664,351 @@ components: type: object title: VectorStoreCreateRequest type: object + VectorStoreDeleteResponse: + description: Response from deleting a vector store. + properties: + id: + title: Id + type: string + object: + default: vector_store.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreDeleteResponse + type: object + VectorStoreFileCounts: + description: File processing status counts for a vector store. + properties: + completed: + title: Completed + type: integer + cancelled: + title: Cancelled + type: integer + failed: + title: Failed + type: integer + in_progress: + title: In Progress + type: integer + total: + title: Total + type: integer + required: + - completed + - cancelled + - failed + - in_progress + - total + title: VectorStoreFileCounts + type: object + VectorStoreFileBatchObject: + description: OpenAI Vector Store File Batch object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file_batch + title: Object + type: string + created_at: + title: Created At + type: integer + vector_store_id: + title: Vector Store Id + type: string + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + required: + - id + - created_at + - vector_store_id + - status + - file_counts + title: VectorStoreFileBatchObject + type: object + VectorStoreFileContentResponse: + description: Represents the parsed content of a vector store file. + properties: + object: + const: vector_store.file_content.page + default: vector_store.file_content.page + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreContent' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + title: VectorStoreFileContentResponse + type: object + VectorStoreFileDeleteResponse: + description: Response from deleting a vector store file. + properties: + id: + title: Id + type: string + object: + default: vector_store.file.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreFileDeleteResponse + type: object + VectorStoreFileLastError: + description: Error information for failed vector store file processing. + properties: + code: + title: Code + type: string + enum: + - server_error + - rate_limit_exceeded + default: server_error + message: + title: Message + type: string + required: + - code + - message + title: VectorStoreFileLastError + type: object + VectorStoreFileObject: + description: OpenAI Vector Store File object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file + title: Object + type: string + attributes: + additionalProperties: true + title: Attributes + type: object + chunking_strategy: + discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + created_at: + title: Created At + type: integer + last_error: + anyOf: + - $ref: '#/components/schemas/VectorStoreFileLastError' + title: VectorStoreFileLastError + - type: 'null' + nullable: true + title: VectorStoreFileLastError + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + vector_store_id: + title: Vector Store Id + type: string + required: + - id + - chunking_strategy + - created_at + - status + - vector_store_id + title: VectorStoreFileObject + type: object + VectorStoreFilesListInBatchResponse: + description: Response from listing files in a vector store file batch. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreFilesListInBatchResponse + type: object + VectorStoreListFilesResponse: + description: Response from listing files in a vector store. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListFilesResponse + type: object + VectorStoreObject: + description: OpenAI Vector Store object. + properties: + id: + title: Id + type: string + object: + default: vector_store + title: Object + type: string + created_at: + title: Created At + type: integer + name: + anyOf: + - type: string + - type: 'null' + nullable: true + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + status: + default: completed + title: Status + type: string + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + last_active_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - id + - created_at + - file_counts + title: VectorStoreObject + type: object + VectorStoreListResponse: + description: Response from listing vector stores. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListResponse + type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: @@ -11762,149 +10101,34 @@ components: - content title: VectorStoreSearchResponse type: object - _safety_run_shield_Request: + VectorStoreSearchResponsePage: + description: Paginated response from searching a vector store. properties: - shield_id: - title: Shield Id + object: + default: vector_store.search_results.page + title: Object type: string - messages: + search_query: items: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Messages + type: string + title: Search Query type: array - params: - additionalProperties: true - title: Params - type: object + data: + items: + $ref: '#/components/schemas/VectorStoreSearchResponse' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true required: - - shield_id - - messages - - params - title: _safety_run_shield_Request + - search_query + - data + title: VectorStoreSearchResponsePage type: object - OpenAIResponseMessageOutputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageOutputOneOf - title: OpenAIResponseMessage-Output | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageOutputUnion - OpenAIResponseMessageInputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageInputOneOf - title: OpenAIResponseMessage-Input | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageInputUnion - responses: - BadRequest400: - description: The request was invalid or malformed - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 400 - title: Bad Request - detail: The request was invalid or malformed - TooManyRequests429: - description: The client has sent too many requests in a given amount of time - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 429 - title: Too Many Requests - detail: You have exceeded the rate limit. Please try again later. - InternalServerError500: - description: The server encountered an unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 500 - title: Internal Server Error - detail: An unexpected error occurred - DefaultError: - description: An error occurred - content: - application/json: - schema: - $ref: '#/components/schemas/Error' diff --git a/docs/static/stainless-llama-stack-spec.yaml b/docs/static/stainless-llama-stack-spec.yaml index fc8340435..cc0533382 100644 --- a/docs/static/stainless-llama-stack-spec.yaml +++ b/docs/static/stainless-llama-stack-spec.yaml @@ -14,1412 +14,18 @@ info: servers: - url: http://any-hosted-llama-stack.com paths: - /v1/batches: - get: - responses: - '200': - description: A list of batch objects. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBatchesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - post: - responses: - '200': - description: The created batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $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. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBatchRequest' - required: true - deprecated: false - /v1/batches/{batch_id}: - get: - responses: - '200': - description: The batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $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. - parameters: - - 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: - responses: - '200': - description: The updated batch object. - content: - application/json: - schema: - $ref: '#/components/schemas/Batch' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - /v1/chat/completions: - get: - responses: - '200': - description: A ListOpenAIChatCompletionResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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' - deprecated: false - post: - responses: - '200': - description: An OpenAIChatCompletion. - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletion' - - $ref: '#/components/schemas/OpenAIChatCompletionChunk' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Create chat completions. - description: >- - Create chat completions. - - Generate an OpenAI-compatible chat completion for the given messages using - the specified model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' - required: true - deprecated: false - /v1/chat/completions/{completion_id}: - get: - responses: - '200': - description: A OpenAICompletionWithInputMessages. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Get chat completion. - description: >- - Get chat completion. - - Describe a chat completion by its ID. - parameters: - - name: completion_id - in: path - description: ID of the chat completion. - required: true - schema: - type: string - deprecated: false - /v1/completions: - post: - responses: - '200': - description: An OpenAICompletion. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletion' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Create completion. - description: >- - Create completion. - - Generate an OpenAI-compatible completion for the given prompt using the specified - model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' - required: true - deprecated: false - /v1/conversations: - post: - responses: - '200': - description: The created conversation object. - content: - application/json: - schema: - $ref: '#/components/schemas/Conversation' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Create a conversation. - description: >- - Create a conversation. - - Create a conversation. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateConversationRequest' - required: true - deprecated: false - /v1/conversations/{conversation_id}: - get: - responses: - '200': - description: The conversation object. - content: - application/json: - schema: - $ref: '#/components/schemas/Conversation' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Retrieve a conversation. - description: >- - Retrieve a conversation. - - Get a conversation with the given ID. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - deprecated: false - post: - responses: - '200': - description: The updated conversation object. - content: - application/json: - schema: - $ref: '#/components/schemas/Conversation' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Update a conversation. - description: >- - Update a conversation. - - Update a conversation's metadata with the given ID. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConversationRequest' - required: true - deprecated: false - delete: - responses: - '200': - description: The deleted conversation resource. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationDeletedResource' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Delete a conversation. - description: >- - Delete a conversation. - - Delete a conversation with the given ID. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - deprecated: false - /v1/conversations/{conversation_id}/items: - get: - responses: - '200': - description: List of conversation items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: List items. - description: >- - List items. - - 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: - type: string - enum: - - asc - - desc - deprecated: false - post: - responses: - '200': - description: List of created items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Create items. - description: >- - Create items. - - Create items in the conversation. - parameters: - - name: conversation_id - in: path - description: The conversation identifier. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddItemsRequest' - required: true - deprecated: false - /v1/conversations/{conversation_id}/items/{item_id}: - get: - responses: - '200': - description: The conversation item. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItem' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Retrieve an item. - description: >- - Retrieve an 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 - deprecated: false - delete: - responses: - '200': - description: The deleted item resource. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemDeletedResource' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Conversations - summary: Delete an item. - description: >- - Delete an 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 - deprecated: false - /v1/embeddings: - post: - responses: - '200': - description: >- - An OpenAIEmbeddingsResponse containing the embeddings. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inference - summary: Create embeddings. - description: >- - Create embeddings. - - Generate OpenAI-compatible embeddings for the given input using the specified - model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' - required: true - deprecated: false - /v1/files: - get: - responses: - '200': - description: >- - An ListOpenAIFileResponse containing the list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIFileResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: List files. - description: >- - List files. - - 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' - deprecated: false - post: - responses: - '200': - description: >- - An OpenAIFileObject representing the uploaded file. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: Upload file. - description: >- - Upload file. - - Upload a file that can be used across various endpoints. - - - The file upload should be a multipart form request with: - - - file: The File object (not file name) to be uploaded. - - - purpose: The intended purpose of the uploaded file. - - - expires_after: Optional form values describing expiration for the file. - parameters: [] - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - expires_after: - $ref: '#/components/schemas/ExpiresAfter' - required: - - file - - purpose - required: true - deprecated: false - /v1/files/{file_id}: - get: - responses: - '200': - description: >- - An OpenAIFileObject containing file information. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: Retrieve file. - description: >- - Retrieve 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 - deprecated: false - delete: - responses: - '200': - description: >- - An OpenAIFileDeleteResponse indicating successful deletion. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIFileDeleteResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - /v1/files/{file_id}/content: - get: - responses: - '200': - description: >- - The raw file content as a binary response. - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Files - summary: Retrieve file content. - description: >- - Retrieve file content. - - 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 - deprecated: false - /v1/health: - get: - responses: - '200': - description: >- - Health information indicating if the service is operational. - content: - application/json: - schema: - $ref: '#/components/schemas/HealthInfo' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inspect - summary: Get health status. - description: >- - Get health status. - - 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. - content: - application/json: - schema: - $ref: '#/components/schemas/ListRoutesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Inspect - summary: List routes. - description: >- - List routes. - - 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 all non-deprecated routes. - required: false - schema: - type: string - enum: - - v1 - - v1alpha - - v1beta - - deprecated - deprecated: false - /v1/models: - get: - responses: - '200': - description: A OpenAIListModelsResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIListModelsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: List models using the OpenAI API. - description: List models using the OpenAI API. - parameters: [] - deprecated: false - post: - responses: - '200': - description: A Model. - content: - application/json: - schema: - $ref: '#/components/schemas/Model' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: Register model. - description: >- - Register model. - - Register a model. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterModelRequest' - required: true - deprecated: true - /v1/models/{model_id}: - get: - responses: - '200': - description: A Model. - content: - application/json: - schema: - $ref: '#/components/schemas/Model' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: Get model. - description: >- - Get model. - - 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 - deprecated: false - delete: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Models - summary: Unregister model. - description: >- - Unregister model. - - Unregister a model. - parameters: - - name: model_id - in: path - description: >- - The identifier of the model to unregister. - required: true - schema: - type: string - deprecated: true - /v1/moderations: - post: - responses: - '200': - description: A moderation object. - content: - application/json: - schema: - $ref: '#/components/schemas/ModerationObject' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Safety - summary: Create moderation. - description: >- - Create moderation. - - Classifies if text and/or image inputs are potentially harmful. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RunModerationRequest' - required: true - deprecated: false - /v1/prompts: - get: - responses: - '200': - description: >- - A ListPromptsResponse containing all prompts. - content: - application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: List all prompts. - description: List all prompts. - parameters: [] - deprecated: false - post: - responses: - '200': - description: The created Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Create prompt. - description: >- - Create prompt. - - Create a new prompt. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePromptRequest' - required: true - deprecated: false - /v1/prompts/{prompt_id}: - get: - responses: - '200': - description: A Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Get prompt. - description: >- - Get prompt. - - 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 - deprecated: false - post: - responses: - '200': - description: >- - The updated Prompt resource with incremented version. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Update prompt. - description: >- - Update prompt. - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdatePromptRequest' - required: true - deprecated: false - delete: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Delete prompt. - description: >- - Delete prompt. - - Delete a prompt. - parameters: - - 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. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: Set prompt version. - description: >- - Set prompt version. - - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetDefaultVersionRequest' - required: true - deprecated: false - /v1/prompts/{prompt_id}/versions: - get: - responses: - '200': - description: >- - A ListPromptsResponse containing all versions of the prompt. - content: - application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Prompts - summary: List prompt versions. - description: >- - List prompt versions. - - 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 - deprecated: false - /v1/providers: - get: - responses: - '200': - description: >- - A ListProvidersResponse containing information about all providers. - content: - application/json: - schema: - $ref: '#/components/schemas/ListProvidersResponse' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Providers - summary: List providers. - description: >- - List providers. - - List all available providers. - parameters: [] - deprecated: false /v1/providers/{provider_id}: get: tags: - Providers summary: Inspect Provider - description: |- - Get provider. - - Get detailed information about a specific provider. operationId: inspect_provider_v1_providers__provider_id__get responses: '200': - description: A ProviderInfo object containing the provider's details. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ProviderInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1444,18 +50,13 @@ paths: tags: - Providers summary: List Providers - description: |- - List providers. - - List all available providers. operationId: list_providers_v1_providers_get responses: '200': - description: A ListProvidersResponse containing information about all providers. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListProvidersResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1473,134 +74,60 @@ paths: tags: - Agents summary: List Openai Responses - description: List all responses. operationId: list_openai_responses_v1_responses_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 50 - title: Limit - - name: model - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Model - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order responses: '200': - description: A ListOpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIResponseObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Agents summary: Create Openai Response - description: Create a model response. operationId: create_openai_response_v1_responses_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_responses_Request' - x-llama-stack-extra-body-params: - guardrails: - $defs: - ResponseGuardrailSpec: - description: |- - Specification for a guardrail to apply during response generation. - - :param type: The type/identifier of the guardrail. - properties: - type: - title: Type - type: string - required: - - type - title: ResponseGuardrailSpec - type: object - anyOf: - - items: - anyOf: - - type: string - - $ref: '#/components/schemas/ResponseGuardrailSpec' - type: array - - type: 'null' - description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation. responses: '200': - description: An OpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseObject' - text/event-stream: - schema: - $ref: '#/components/schemas/OpenAIResponseObjectStream' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/responses/{response_id}: get: tags: - Agents summary: Get Openai Response - description: Get a model response. operationId: get_openai_response_v1_responses__response_id__get responses: '200': - description: An OpenAIResponseObject. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1624,15 +151,13 @@ paths: tags: - Agents summary: Delete Openai Response - description: Delete a response. operationId: delete_openai_response_v1_responses__response_id__delete responses: '200': - description: An OpenAIDeleteResponseObject + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIDeleteResponseObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1657,95 +182,44 @@ paths: tags: - Agents summary: List Openai Response Input Items - description: List input items. operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order - name: response_id in: path required: true schema: type: string description: 'Path parameter: response_id' - - name: include - in: query - required: false - schema: - anyOf: - - type: array - items: - type: string - - type: 'null' - title: Include - responses: - '200': - description: An ListOpenAIResponseInputItem. - content: - application/json: - schema: - $ref: '#/components/schemas/ListOpenAIResponseInputItem' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/chat/completions/{completion_id}: get: tags: - Inference summary: Get Chat Completion - description: |- - Get chat completion. - - Describe a chat completion by its ID. operationId: get_chat_completion_v1_chat_completions__completion_id__get responses: '200': - description: A OpenAICompletionWithInputMessages. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1770,180 +244,60 @@ paths: tags: - Inference summary: List Chat Completions - description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: model - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Model - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order responses: '200': - description: A ListOpenAIChatCompletionResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response - post: - tags: - - ScoringFunctions - summary: List all scoring functions. - description: List all scoring functions. - parameters: [] - deprecated: false - post: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: $ref: '#/components/responses/DefaultError' + post: tags: - - ScoringFunctions - summary: Register a scoring function. - description: Register a scoring function. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterScoringFunctionRequest' - required: true - deprecated: true - /v1/scoring-functions/{scoring_fn_id}: - get: + - Inference + summary: Openai Chat Completion + operationId: openai_chat_completion_v1_chat_completions_post responses: '200': - description: An OpenAIChatCompletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIChatCompletion' - text/event-stream: - schema: - $ref: '#/components/schemas/OpenAIChatCompletionChunk' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - delete: - responses: - '200': - description: OK - '400': $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: + description: Default Response $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: true - /v1/scoring/score: + /v1/completions: post: tags: - Inference summary: Openai Completion - description: |- - Create completion. - - Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' - required: true responses: '200': - description: An OpenAICompletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAICompletion' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1961,24 +315,13 @@ paths: tags: - Inference summary: Openai Embeddings - description: |- - Create embeddings. - - Generate OpenAI-compatible embeddings for the given input using the specified model. operationId: openai_embeddings_v1_embeddings_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' - required: true responses: '200': - description: An OpenAIEmbeddingsResponse containing the embeddings. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIEmbeddingsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -1994,50 +337,15 @@ paths: /v1alpha/inference/rerank: post: tags: - - Shields - summary: List all shields. - description: List all shields. - parameters: [] - deprecated: false - post: + - Inference + summary: Rerank + operationId: rerank_v1alpha_inference_rerank_post responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - Shields - summary: Register a shield. - description: Register a shield. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterShieldRequest' - required: true - deprecated: true - /v1/shields/{identifier}: - get: - responses: - '200': - description: RerankResponse with indices sorted by relevance score (descending). - content: - application/json: - schema: - $ref: '#/components/schemas/RerankResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2055,18 +363,13 @@ paths: tags: - Inspect summary: Health - description: |- - Get health status. - - Get the current health status of the service. operationId: health_v1_health_get responses: '200': - description: Health information indicating if the service is operational. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/HealthInfo' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2084,65 +387,61 @@ paths: tags: - Inspect summary: List Routes - description: |- - List routes. - - List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get - parameters: - - name: api_filter - in: query - required: false - schema: - anyOf: - - enum: - - v1 - - v1alpha - - v1beta - - deprecated - type: string - deprecated: false - delete: responses: '200': - description: OK + description: Successful Response + content: + application/json: + schema: {} '400': + description: Bad Request $ref: '#/components/responses/BadRequest400' '429': - $ref: >- - #/components/responses/TooManyRequests429 + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: >- - #/components/responses/InternalServerError500 + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: + description: Default Response $ref: '#/components/responses/DefaultError' + /v1/version: + get: tags: - - 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 - deprecated: true - /v1/tool-runtime/invoke: + - Inspect + summary: Version + operationId: version_v1_version_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' + /v1/batches/{batch_id}/cancel: post: tags: - Batches summary: Cancel Batch - description: Cancel a batch that is in progress. operationId: cancel_batch_v1_batches__batch_id__cancel_post responses: '200': - description: The updated batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2165,160 +464,62 @@ paths: /v1/batches: get: tags: - - ToolGroups - summary: List tool groups with optional provider. - description: List tool groups with optional provider. - parameters: [] - deprecated: false - post: + - Batches + summary: List Batches + operationId: list_batches_v1_batches_get responses: '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - ToolGroups - summary: Register a tool group. - description: Register a tool group. - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterToolGroupRequest' - required: true - deprecated: true - /v1/toolgroups/{toolgroup_id}: - get: - responses: - '200': - description: A ToolGroup. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolGroup' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: false - delete: - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequest400' - '429': - $ref: >- - #/components/responses/TooManyRequests429 - '500': - $ref: >- - #/components/responses/InternalServerError500 - default: - $ref: '#/components/responses/DefaultError' - tags: - - 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 - deprecated: true - /v1/tools: - get: - responses: - '200': - description: A list of batch objects. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBatchesResponse' - '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Batches summary: Create Batch - description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_batches_Request' responses: '200': - description: The created batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/batches/{batch_id}: get: tags: - Batches summary: Retrieve Batch - description: Retrieve information about a specific batch. operationId: retrieve_batch_v1_batches__batch_id__get responses: '200': - description: The batch object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Batch' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2343,17 +544,7 @@ paths: tags: - Vector Io summary: Insert Chunks - description: Insert chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Chunk-Input' - title: Chunks responses: '200': description: Successful Response @@ -2361,128 +552,71 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/files: get: tags: - Vector Io summary: Openai List Files In Vector Store - description: List files in a vector store. operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: filter - in: query - required: false - schema: - title: Filter - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - nullable: true - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order - name: vector_store_id in: path required: true schema: type: string description: 'Path parameter: vector_store_id' - responses: - '200': - description: A VectorStoreListFilesResponse containing the list of files. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreListFilesResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Vector Io summary: Openai Attach File To Vector Store - description: Attach a file to a vector store. operationId: openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_files_Request' responses: '200': - description: A VectorStoreFileObject representing the attached file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: vector_store_id in: path @@ -2495,15 +629,13 @@ paths: tags: - Vector Io summary: Openai Cancel Vector Store File Batch - description: Cancels a vector store file batch. operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post responses: '200': - description: A VectorStoreFileBatchObject representing the cancelled file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2534,119 +666,60 @@ paths: tags: - Vector Io summary: Openai List Vector Stores - description: Returns a list of vector stores. operationId: openai_list_vector_stores_v1_vector_stores_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order responses: '200': - description: A VectorStoreListResponse containing the list of vector stores. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreListResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Vector Io summary: Openai Create Vector Store - description: |- - Creates a vector store. - - Generate an OpenAI-compatible vector store with the given parameters. operationId: openai_create_vector_store_v1_vector_stores_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' responses: '200': - description: A VectorStoreObject representing the created vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/vector_stores/{vector_store_id}/file_batches: post: tags: - Vector Io summary: Openai Create Vector Store File Batch - description: |- - Create a vector store file batch. - - Generate an OpenAI-compatible vector store file batch for the given vector store. operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' - required: true responses: '200': - description: A VectorStoreFileBatchObject representing the created file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2671,15 +744,13 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store - description: Retrieves a vector store. operationId: openai_retrieve_vector_store_v1_vector_stores__vector_store_id__get responses: '200': - description: A VectorStoreObject representing the vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2703,21 +774,13 @@ paths: tags: - Vector Io summary: Openai Update Vector Store - description: Updates a vector store. operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_Request' - required: true responses: '200': - description: A VectorStoreObject representing the updated vector store. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2741,15 +804,13 @@ paths: tags: - Vector Io summary: Openai Delete Vector Store - description: Delete a vector store. operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete responses: '200': - description: A VectorStoreDeleteResponse indicating the deletion status. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2774,15 +835,13 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store File - description: Retrieves a vector store file. operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get responses: '200': - description: A VectorStoreFileObject representing the file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2812,21 +871,13 @@ paths: tags: - Vector Io summary: Openai Update Vector Store File - description: Updates a vector store file. operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_files_file_id_Request' - required: true responses: '200': - description: A VectorStoreFileObject representing the updated file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2856,15 +907,13 @@ paths: tags: - Vector Io summary: Openai Delete Vector Store File - description: Delete a vector store file. operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete responses: '200': - description: A VectorStoreFileDeleteResponse indicating the deletion status. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -2895,51 +944,26 @@ paths: tags: - Vector Io summary: Openai List Files In Vector Store File Batch - description: Returns a list of vector store files in a batch. operationId: openai_list_files_in_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: before - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Before - - name: filter - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Filter - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 20 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - default: desc - title: Order - name: vector_store_id in: path required: true @@ -2952,39 +976,18 @@ paths: schema: type: string description: 'Path parameter: batch_id' - responses: - '200': - description: A VectorStoreFilesListInBatchResponse containing the list of files in the batch. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}: get: tags: - Vector Io summary: Openai Retrieve Vector Store File Batch - description: Retrieve a vector store file batch. operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get responses: '200': - description: A VectorStoreFileBatchObject representing the file batch. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileBatchObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3015,27 +1018,26 @@ paths: tags: - Vector Io summary: Openai Retrieve Vector Store File Contents - description: Retrieves the contents of a vector store file. operationId: openai_retrieve_vector_store_file_contents_v1_vector_stores__vector_store_id__files__file_id__content_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: include_embeddings - in: query - required: false - schema: - anyOf: - - type: boolean - - type: 'null' - default: false - title: Include Embeddings - - name: include_metadata - in: query - required: false - schema: - anyOf: - - type: boolean - - type: 'null' - default: false - title: Include Metadata - name: vector_store_id in: path required: true @@ -3048,48 +1050,18 @@ paths: schema: type: string description: 'Path parameter: file_id' - responses: - '200': - description: File contents, optionally with embeddings and metadata based on query parameters. - content: - application/json: - schema: - $ref: '#/components/schemas/VectorStoreFileContentResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1/vector_stores/{vector_store_id}/search: post: tags: - Vector Io summary: Openai Search Vector Store - description: |- - Search for chunks in a vector store. - - Searches a vector store for relevant chunks based on a query and optional file attribute filters. operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_stores_vector_store_id_search_Request' - required: true responses: '200': - description: A VectorStoreSearchResponse containing the search results. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/VectorStoreSearchResponsePage' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3114,21 +1086,13 @@ paths: tags: - Vector Io summary: Query Chunks - description: Query chunks from a vector database. operationId: query_chunks_v1_vector_io_query_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_vector_io_query_Request' - required: true responses: '200': - description: A QueryChunksResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/QueryChunksResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3146,18 +1110,13 @@ paths: tags: - Models summary: Get Model - description: |- - Get model. - - Get a model by its identifier. operationId: get_model_v1_models__model_id__get responses: '200': - description: A Model. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Model' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3182,15 +1141,13 @@ paths: tags: - Models summary: Openai List Models - description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get responses: '200': - description: A OpenAIListModelsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIListModelsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3208,24 +1165,13 @@ paths: tags: - Safety summary: Run Moderation - description: |- - Create moderation. - - Classifies if text and/or image inputs are potentially harmful. operationId: run_moderation_v1_moderations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_moderations_Request' - required: true responses: '200': - description: A moderation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ModerationObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3243,24 +1189,13 @@ paths: tags: - Safety summary: Run Shield - description: |- - Run shield. - - Run a shield. operationId: run_shield_v1_safety_run_shield_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_safety_run_shield_Request' - required: true responses: '200': - description: A RunShieldResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/RunShieldResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3278,15 +1213,13 @@ paths: tags: - Shields summary: Get Shield - description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get responses: '200': - description: A Shield. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Shield' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3311,15 +1244,13 @@ paths: tags: - Shields summary: List Shields - description: List all shields. operationId: list_shields_v1_shields_get responses: '200': - description: A ListShieldsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListShieldsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3337,18 +1268,7 @@ paths: tags: - Datasetio summary: Append Rows - description: Append rows to a dataset. operationId: append_rows_v1beta_datasetio_append_rows__dataset_id__post - requestBody: - content: - application/json: - schema: - items: - additionalProperties: true - type: object - type: array - title: Rows - required: true responses: '200': description: Successful Response @@ -3379,73 +1299,44 @@ paths: tags: - Datasetio summary: Iterrows - description: |- - Get a paginated list of rows from a dataset. - - Uses offset-based pagination where: - - start_index: The starting index (0-based). If None, starts from beginning. - - limit: Number of items to return. If None or -1, returns all items. - - The response includes: - - data: List of items for the current page. - - has_more: Whether there are more items available after this set. operationId: iterrows_v1beta_datasetio_iterrows__dataset_id__get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Limit - - name: start_index - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Start Index - name: dataset_id in: path required: true schema: type: string description: 'Path parameter: dataset_id' - responses: - '200': - description: A PaginatedResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response /v1beta/datasets/{dataset_id}: get: tags: - Datasets summary: Get Dataset - description: Get a dataset by its ID. operationId: get_dataset_v1beta_datasets__dataset_id__get responses: '200': - description: A Dataset. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Dataset' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3470,15 +1361,13 @@ paths: tags: - Datasets summary: List Datasets - description: List all datasets. operationId: list_datasets_v1beta_datasets_get responses: '200': - description: A ListDatasetsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListDatasetsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3496,21 +1385,13 @@ paths: tags: - Scoring summary: Score - description: Score a list of rows. operationId: score_v1_scoring_score_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_scoring_score_Request' - required: true responses: '200': - description: A ScoreResponse object containing rows and aggregated results. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoreResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3528,21 +1409,13 @@ paths: tags: - Scoring summary: Score Batch - description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_scoring_score_batch_Request' - required: true responses: '200': - description: A ScoreBatchResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoreBatchResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3560,15 +1433,13 @@ paths: tags: - Scoring Functions summary: Get Scoring Function - description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get responses: '200': - description: A ScoringFn. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ScoringFn' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3593,47 +1464,37 @@ paths: tags: - Scoring Functions summary: List Scoring Functions - description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get responses: '200': - description: A ListScoringFunctionsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListScoringFunctionsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/eval/benchmarks/{benchmark_id}/evaluations: post: tags: - Eval summary: Evaluate Rows - description: Evaluate a list of rows on a benchmark. operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_eval_benchmarks_benchmark_id_evaluations_Request' - required: true responses: '200': - description: EvaluateResponse object containing generations and scores. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/EvaluateResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3658,15 +1519,13 @@ paths: tags: - Eval summary: Job Status - description: Get the status of a job. operationId: job_status_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__get responses: '200': - description: The status of the evaluation job. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Job' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3696,7 +1555,6 @@ paths: tags: - Eval summary: Job Cancel - description: Cancel a job. operationId: job_cancel_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__delete responses: '200': @@ -3734,15 +1592,13 @@ paths: tags: - Eval summary: Job Result - description: Get the result of a job. operationId: job_result_v1alpha_eval_benchmarks__benchmark_id__jobs__job_id__result_get responses: '200': - description: The result of the job. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/EvaluateResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3773,21 +1629,13 @@ paths: tags: - Eval summary: Run Eval - description: Run an evaluation on a benchmark. operationId: run_eval_v1alpha_eval_benchmarks__benchmark_id__jobs_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BenchmarkConfig' - required: true responses: '200': - description: The job that was created to run the evaluation. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Job' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3812,15 +1660,13 @@ paths: tags: - Benchmarks summary: Get Benchmark - description: Get a benchmark by its ID. operationId: get_benchmark_v1alpha_eval_benchmarks__benchmark_id__get responses: '200': - description: A Benchmark. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Benchmark' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3845,41 +1691,7 @@ paths: tags: - Benchmarks summary: List Benchmarks - description: List all benchmarks. operationId: list_benchmarks_v1alpha_eval_benchmarks_get - responses: - '200': - description: A ListBenchmarksResponse. - content: - application/json: - schema: - $ref: '#/components/schemas/ListBenchmarksResponse' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response - /v1alpha/post-training/job/cancel: - post: - tags: - - Post Training - summary: Cancel Training Job - description: Cancel a training job. - operationId: cancel_training_job_v1alpha_post_training_job_cancel_post - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': description: Successful Response @@ -3887,97 +1699,101 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' + /v1alpha/post-training/job/cancel: + post: + tags: + - Post Training + summary: Cancel Training Job + operationId: cancel_training_job_v1alpha_post_training_job_cancel_post + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/artifacts: get: tags: - Post Training summary: Get Training Job Artifacts - description: Get the artifacts of a training job. operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': - description: A PostTrainingJobArtifactsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/job/status: get: tags: - Post Training summary: Get Training Job Status - description: Get the status of a training job. operationId: get_training_job_status_v1alpha_post_training_job_status_get - parameters: - - name: job_uuid - in: query - required: true - schema: - type: string - title: Job Uuid responses: '200': - description: A PostTrainingJobStatusResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJobStatusResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1alpha/post-training/jobs: get: tags: - Post Training summary: Get Training Jobs - description: Get all training jobs. operationId: get_training_jobs_v1alpha_post_training_jobs_get responses: '200': - description: A ListPostTrainingJobsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPostTrainingJobsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -3995,21 +1811,13 @@ paths: tags: - Post Training summary: Preference Optimize - description: Run preference optimization of a model. operationId: preference_optimize_v1alpha_post_training_preference_optimize_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_post_training_preference_optimize_Request' - required: true responses: '200': - description: A PostTrainingJob. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJob' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4027,21 +1835,13 @@ paths: tags: - Post Training summary: Supervised Fine Tune - description: Run supervised fine-tuning of a model. operationId: supervised_fine_tune_v1alpha_post_training_supervised_fine_tune_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_post_training_supervised_fine_tune_Request' - required: true responses: '200': - description: A PostTrainingJob. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/PostTrainingJob' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4059,15 +1859,13 @@ paths: tags: - Tool Groups summary: Get Tool - description: Get a tool by its name. operationId: get_tool_v1_tools__tool_name__get responses: '200': - description: A ToolDef. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolDef' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4092,15 +1890,13 @@ paths: tags: - Tool Groups summary: Get Tool Group - description: Get a tool group by its ID. operationId: get_tool_group_v1_toolgroups__toolgroup_id__get responses: '200': - description: A ToolGroup. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolGroup' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4125,82 +1921,61 @@ paths: tags: - Tool Groups summary: List Tool Groups - description: List tool groups with optional provider. operationId: list_tool_groups_v1_toolgroups_get responses: '200': - description: A ListToolGroupsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolGroupsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tools: get: tags: - Tool Groups summary: List Tools - description: List tools with optional tool group. operationId: list_tools_v1_tools_get - parameters: - - name: toolgroup_id - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Toolgroup Id responses: '200': - description: A ListToolDefsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolDefsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/tool-runtime/invoke: post: tags: - Tool Runtime summary: Invoke Tool - description: Run a tool with the given arguments. operationId: invoke_tool_v1_tool_runtime_invoke_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_tool_runtime_invoke_Request' - required: true responses: '200': - description: A ToolInvocationResult. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ToolInvocationResult' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4218,61 +1993,37 @@ paths: tags: - Tool Runtime summary: List Runtime Tools - description: List all tools in the runtime. operationId: list_runtime_tools_v1_tool_runtime_list_tools_get - parameters: - - name: tool_group_id - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: Tool Group Id - - name: mcp_endpoint - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/URL' - - type: 'null' - title: Mcp Endpoint responses: '200': - description: A ListToolDefsResponse. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListToolDefsResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/files/{file_id}: get: tags: - Files summary: Openai Retrieve File - description: |- - Retrieve file. - - Returns information about a specific file. operationId: openai_retrieve_file_v1_files__file_id__get responses: '200': - description: An OpenAIFileObject containing file information. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4296,15 +2047,13 @@ paths: tags: - Files summary: Openai Delete File - description: Delete file. operationId: openai_delete_file_v1_files__file_id__delete responses: '200': - description: An OpenAIFileDeleteResponse indicating successful deletion. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileDeleteResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4329,117 +2078,57 @@ paths: tags: - Files summary: Openai List Files - description: |- - List files. - - Returns a list of files that belong to the user's organization. operationId: openai_list_files_v1_files_get - parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - default: 10000 - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/Order' - - type: 'null' - default: desc - title: Order - - name: purpose - in: query - required: false - schema: - anyOf: - - $ref: '#/components/schemas/OpenAIFilePurpose' - - type: 'null' - title: Purpose responses: '200': - description: An ListOpenAIFileResponse containing the list of files. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListOpenAIFileResponse' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' post: tags: - Files summary: Openai Upload File - description: |- - Upload file. - - Upload a file that can be used across various endpoints. - - The file upload should be a multipart form request with: - - file: The File object (not file name) to be uploaded. - - purpose: The intended purpose of the uploaded file. - - expires_after: Optional form values describing expiration for the file. operationId: openai_upload_file_v1_files_post - requestBody: - required: true - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/Body_openai_upload_file_v1_files_post' responses: '200': - description: An OpenAIFileObject representing the uploaded file. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIFileObject' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' /v1/files/{file_id}/content: get: tags: - Files summary: Openai Retrieve File Content - description: |- - Retrieve file content. - - Returns the contents of the specified file. operationId: openai_retrieve_file_content_v1_files__file_id__content_get responses: '200': - description: The raw file content as a binary response. + description: Successful Response content: application/json: schema: {} @@ -4467,15 +2156,13 @@ paths: tags: - Prompts summary: List Prompts - description: List all prompts. operationId: list_prompts_v1_prompts_get responses: '200': - description: A ListPromptsResponse containing all prompts. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4492,24 +2179,13 @@ paths: tags: - Prompts summary: Create Prompt - description: |- - Create prompt. - - Create a new prompt. operationId: create_prompt_v1_prompts_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_Request' - required: true responses: '200': - description: The created Prompt resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4527,79 +2203,55 @@ paths: tags: - Prompts summary: Get Prompt - description: |- - Get prompt. - - Get a prompt by its identifier and optional version. operationId: get_prompt_v1_prompts__prompt_id__get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: version - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Version - name: prompt_id in: path required: true schema: type: string description: 'Path parameter: prompt_id' - responses: - '200': - description: A Prompt resource. - content: - application/json: - schema: - $ref: '#/components/schemas/Prompt' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Prompts summary: Update Prompt - description: |- - Update prompt. - - Update an existing prompt (increments version). operationId: update_prompt_v1_prompts__prompt_id__post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_prompt_id_Request' responses: '200': - description: The updated Prompt resource with incremented version. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path @@ -4611,10 +2263,6 @@ paths: tags: - Prompts summary: Delete Prompt - description: |- - Delete prompt. - - Delete a prompt. operationId: delete_prompt_v1_prompts__prompt_id__delete responses: '200': @@ -4623,17 +2271,17 @@ paths: application/json: schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: prompt_id in: path @@ -4646,18 +2294,13 @@ paths: tags: - Prompts summary: List Prompt Versions - description: |- - List prompt versions. - - List all versions of a specific prompt. operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get responses: '200': - description: A ListPromptsResponse containing all versions of the prompt. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ListPromptsResponse' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4682,24 +2325,13 @@ paths: tags: - Prompts summary: Set Default Version - description: |- - Set prompt version. - - Set which version of a prompt should be the default in get_prompt (latest). operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_prompts_prompt_id_set_default_version_Request' - required: true responses: '200': - description: The prompt with the specified version now set as default. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Prompt' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4724,108 +2356,55 @@ paths: tags: - Conversations summary: List Items - description: |- - List items. - - List items in the conversation. operationId: list_items_v1_conversations__conversation_id__items_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '400': + description: Bad Request + $ref: '#/components/responses/BadRequest400' + '429': + description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' + '500': + description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' + default: + description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - - name: after - in: query - required: false - schema: - anyOf: - - type: string - - type: 'null' - title: After - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: 'null' - title: Limit - - name: order - in: query - required: false - schema: - anyOf: - - enum: - - asc - - desc - type: string - - type: 'null' - title: Order - name: conversation_id in: path required: true schema: type: string description: 'Path parameter: conversation_id' - - name: include - in: query - required: false - schema: - anyOf: - - type: array - items: - $ref: '#/components/schemas/ConversationItemInclude' - - type: 'null' - title: Include - responses: - '200': - description: List of conversation items. - content: - application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' - '400': - $ref: '#/components/responses/BadRequest400' - description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequests429' - description: Too Many Requests - '500': - $ref: '#/components/responses/InternalServerError500' - description: Internal Server Error - default: - $ref: '#/components/responses/DefaultError' - description: Default Response post: tags: - Conversations summary: Add Items - description: |- - Create items. - - Create items in the conversation. operationId: add_items_v1_conversations__conversation_id__items_post - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_conversation_id_items_Request' responses: '200': - description: List of created items. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationItemList' + schema: {} '400': - $ref: '#/components/responses/BadRequest400' description: Bad Request + $ref: '#/components/responses/BadRequest400' '429': - $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests + $ref: '#/components/responses/TooManyRequests429' '500': - $ref: '#/components/responses/InternalServerError500' description: Internal Server Error + $ref: '#/components/responses/InternalServerError500' default: - $ref: '#/components/responses/DefaultError' description: Default Response + $ref: '#/components/responses/DefaultError' parameters: - name: conversation_id in: path @@ -4838,24 +2417,13 @@ paths: tags: - Conversations summary: Create Conversation - description: |- - Create a conversation. - - Create a conversation. operationId: create_conversation_v1_conversations_post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_Request' - required: true responses: '200': - description: The created conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4873,18 +2441,13 @@ paths: tags: - Conversations summary: Get Conversation - description: |- - Retrieve a conversation. - - Get a conversation with the given ID. operationId: get_conversation_v1_conversations__conversation_id__get responses: '200': - description: The conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4908,24 +2471,13 @@ paths: tags: - Conversations summary: Update Conversation - description: |- - Update a conversation. - - Update a conversation's metadata with the given ID. operationId: update_conversation_v1_conversations__conversation_id__post - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/_conversations_conversation_id_Request' - required: true responses: '200': - description: The updated conversation object. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/Conversation' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4949,18 +2501,13 @@ paths: tags: - Conversations summary: Openai Delete Conversation - description: |- - Delete a conversation. - - Delete a conversation with the given ID. operationId: openai_delete_conversation_v1_conversations__conversation_id__delete responses: '200': - description: The deleted conversation resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationDeletedResource' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -4985,18 +2532,13 @@ paths: tags: - Conversations summary: Retrieve - description: |- - Retrieve an item. - - Retrieve a conversation item. operationId: retrieve_v1_conversations__conversation_id__items__item_id__get responses: '200': - description: The conversation item. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/OpenAIResponseMessage' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -5026,18 +2568,13 @@ paths: tags: - Conversations summary: Openai Delete Conversation Item - description: |- - Delete an item. - - Delete a conversation item. operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete responses: '200': - description: The deleted item resource. + description: Successful Response content: application/json: - schema: - $ref: '#/components/schemas/ConversationItemDeletedResource' + schema: {} '400': description: Bad Request $ref: '#/components/responses/BadRequest400' @@ -5064,5965 +2601,44 @@ paths: type: string description: 'Path parameter: item_id' components: + responses: + BadRequest400: + description: The request was invalid or malformed + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 400 + title: Bad Request + detail: The request was invalid or malformed + TooManyRequests429: + description: The client has sent too many requests in a given amount of time + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 429 + title: Too Many Requests + detail: You have exceeded the rate limit. Please try again later. + InternalServerError500: + description: The server encountered an unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + status: 500 + title: Internal Server Error + detail: An unexpected error occurred + DefaultError: + description: An error occurred + content: + application/json: + schema: + $ref: '#/components/schemas/Error' schemas: - AggregationFunctionType: - type: string - enum: - - average - - weighted_average - - median - - categorical_count - - accuracy - title: AggregationFunctionType - description: Types of aggregation functions for scoring results. - AllowedToolsFilter: - properties: - tool_names: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: AllowedToolsFilter - description: Filter configuration for restricting which MCP tools can be used. - ApprovalFilter: - properties: - always: - anyOf: - - items: - type: string - type: array - - type: 'null' - never: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: ApprovalFilter - description: Filter configuration for MCP tool approval requirements. - ArrayType: - properties: - type: - type: string - const: array - title: Type - default: array - type: object - title: ArrayType - description: Parameter type for array values. - BasicScoringFnParams: - properties: - type: - type: string - const: basic - title: Type - default: basic - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: BasicScoringFnParams - description: Parameters for basic scoring function configuration. - Batch: - properties: - id: - type: string - title: Id - completion_window: - type: string - title: Completion Window - created_at: - type: integer - title: Created At - endpoint: - type: string - title: Endpoint - input_file_id: - type: string - title: Input File Id - object: - type: string - const: batch - title: Object - status: - type: string - enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled - title: Status - cancelled_at: - anyOf: - - type: integer - - type: 'null' - cancelling_at: - anyOf: - - type: integer - - type: 'null' - completed_at: - anyOf: - - type: integer - - type: 'null' - error_file_id: - anyOf: - - type: string - - type: 'null' - errors: - anyOf: - - $ref: '#/components/schemas/Errors' - title: Errors - - type: 'null' - title: Errors - expired_at: - anyOf: - - type: integer - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - failed_at: - anyOf: - - type: integer - - type: 'null' - finalizing_at: - anyOf: - - type: integer - - type: 'null' - in_progress_at: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - model: - anyOf: - - type: string - - type: 'null' - output_file_id: - anyOf: - - type: string - - type: 'null' - request_counts: - anyOf: - - $ref: '#/components/schemas/BatchRequestCounts' - title: BatchRequestCounts - - type: 'null' - title: BatchRequestCounts - usage: - anyOf: - - $ref: '#/components/schemas/BatchUsage' - title: BatchUsage - - type: 'null' - title: BatchUsage - additionalProperties: true - type: object - required: - - id - - completion_window - - created_at - - endpoint - - input_file_id - - object - - status - title: Batch - BatchError: - properties: - code: - anyOf: - - type: string - - type: 'null' - line: - anyOf: - - type: integer - - type: 'null' - message: - anyOf: - - type: string - - type: 'null' - param: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: BatchError - BatchRequestCounts: - properties: - completed: - type: integer - title: Completed - failed: - type: integer - title: Failed - total: - type: integer - title: Total - additionalProperties: true - type: object - required: - - completed - - failed - - total - title: BatchRequestCounts - BatchUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - input_tokens_details: - $ref: '#/components/schemas/InputTokensDetails' - output_tokens: - type: integer - title: Output Tokens - output_tokens_details: - $ref: '#/components/schemas/OutputTokensDetails' - total_tokens: - type: integer - title: Total Tokens - additionalProperties: true - type: object - required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens - title: BatchUsage - Benchmark: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: benchmark - title: Type - default: benchmark - dataset_id: - type: string - title: Dataset Id - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - metadata: - additionalProperties: true - type: object - title: Metadata - description: Metadata for this evaluation task - type: object - required: - - identifier - - provider_id - - dataset_id - - scoring_functions - title: Benchmark - description: A benchmark resource for evaluating model performance. - BenchmarkConfig: - properties: - eval_candidate: - $ref: '#/components/schemas/ModelCandidate' - scoring_params: - additionalProperties: - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: object - title: Scoring Params - description: Map between scoring function id and parameters for each scoring function you want to run - num_examples: - anyOf: - - type: integer - - type: 'null' - description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated - type: object - required: - - eval_candidate - title: BenchmarkConfig - description: A benchmark configuration for evaluation. - Body_openai_upload_file_v1_files_post: - properties: - file: - type: string - format: binary - title: File - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - expires_after: - anyOf: - - $ref: '#/components/schemas/ExpiresAfter' - title: ExpiresAfter - - type: 'null' - title: ExpiresAfter - type: object - required: - - file - - purpose - title: Body_openai_upload_file_v1_files_post - BooleanType: - properties: - type: - type: string - const: boolean - title: Type - default: boolean - type: object - title: BooleanType - description: Parameter type for boolean values. - ChatCompletionInputType: - properties: - type: - type: string - const: chat_completion_input - title: Type - default: chat_completion_input - type: object - title: ChatCompletionInputType - description: Parameter type for chat completion input. - Checkpoint: - properties: - identifier: - type: string - title: Identifier - created_at: - type: string - format: date-time - title: Created At - epoch: - type: integer - title: Epoch - post_training_job_id: - type: string - title: Post Training Job Id - path: - type: string - title: Path - training_metrics: - anyOf: - - $ref: '#/components/schemas/PostTrainingMetric' - title: PostTrainingMetric - - type: 'null' - title: PostTrainingMetric - type: object - required: - - identifier - - created_at - - epoch - - post_training_job_id - - path - title: Checkpoint - description: Checkpoint created during training runs. - Chunk-Input: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - Chunk-Output: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - title: string | list[ImageContentItem-Output | TextContentItem] - chunk_id: - type: string - title: Chunk Id - metadata: - additionalProperties: true - type: object - title: Metadata - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - type: object - required: - - content - - chunk_id - title: Chunk - description: A chunk of content that can be inserted into a vector database. - ChunkMetadata: - properties: - chunk_id: - anyOf: - - type: string - - type: 'null' - document_id: - anyOf: - - type: string - - type: 'null' - source: - anyOf: - - type: string - - type: 'null' - created_timestamp: - anyOf: - - type: integer - - type: 'null' - updated_timestamp: - anyOf: - - type: integer - - type: 'null' - chunk_window: - anyOf: - - type: string - - type: 'null' - chunk_tokenizer: - anyOf: - - type: string - - type: 'null' - chunk_embedding_model: - anyOf: - - type: string - - type: 'null' - chunk_embedding_dimension: - anyOf: - - type: integer - - type: 'null' - content_token_count: - anyOf: - - type: integer - - type: 'null' - metadata_token_count: - anyOf: - - type: integer - - type: 'null' - type: object - title: ChunkMetadata - description: |- - `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that - will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` - is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. - Use `Chunk.metadata` for metadata that will be used in the context during inference. - CompletionInputType: - properties: - type: - type: string - const: completion_input - title: Type - default: completion_input - type: object - title: CompletionInputType - description: Parameter type for completion input. - Conversation: - properties: - id: - type: string - title: Id - description: The unique ID of the conversation. - object: - type: string - const: conversation - title: Object - description: The object type, which is always conversation. - default: conversation - created_at: - type: integer - title: Created At - description: The time at which the conversation was created, measured in seconds since the Unix epoch. - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. - items: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - description: Initial items to include in the conversation context. You may add up to 20 items at a time. - type: object - required: - - id - - created_at - title: Conversation - description: OpenAI-compatible conversation object. - ConversationDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted conversation identifier - object: - type: string - title: Object - description: Object type - default: conversation.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationDeletedResource - description: Response for deleted conversation. - ConversationItemDeletedResource: - properties: - id: - type: string - title: Id - description: The deleted item identifier - object: - type: string - title: Object - description: Object type - default: conversation.item.deleted - deleted: - type: boolean - title: Deleted - description: Whether the object was deleted - default: true - type: object - required: - - id - title: ConversationItemDeletedResource - description: Response for deleted conversation item. - ConversationItemInclude: - type: string - enum: - - web_search_call.action.sources - - code_interpreter_call.outputs - - computer_call_output.output.image_url - - file_search_call.results - - message.input_image.image_url - - message.output_text.logprobs - - reasoning.encrypted_content - title: ConversationItemInclude - description: Specify additional output data to include in the model response. - ConversationItemList: - properties: - object: - type: string - title: Object - description: Object type - default: list - data: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (9 variants) - type: array - title: Data - description: List of conversation items - first_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the first item in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: The ID of the last item in the list - has_more: - type: boolean - title: Has More - description: Whether there are more items available - default: false - type: object - required: - - data - title: ConversationItemList - description: List of conversation items with pagination. - DPOAlignmentConfig: - properties: - beta: - type: number - title: Beta - loss_type: - $ref: '#/components/schemas/DPOLossType' - default: sigmoid - type: object - required: - - beta - title: DPOAlignmentConfig - description: Configuration for Direct Preference Optimization (DPO) alignment. - DPOLossType: - type: string - enum: - - sigmoid - - hinge - - ipo - - kto_pair - title: DPOLossType - DataConfig: - properties: - dataset_id: - type: string - title: Dataset Id - batch_size: - type: integer - title: Batch Size - shuffle: - type: boolean - title: Shuffle - data_format: - $ref: '#/components/schemas/DatasetFormat' - validation_dataset_id: - anyOf: - - type: string - - type: 'null' - packed: - anyOf: - - type: boolean - - type: 'null' - default: false - train_on_input: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - dataset_id - - batch_size - - shuffle - - data_format - title: DataConfig - description: Configuration for training data and data loading. - Dataset: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: dataset - title: Type - default: dataset - purpose: - $ref: '#/components/schemas/DatasetPurpose' - source: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource - discriminator: - propertyName: type - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this dataset - type: object - required: - - identifier - - provider_id - - purpose - - source - title: Dataset - description: Dataset resource for storing and accessing training or evaluation data. - DatasetFormat: - type: string - enum: - - instruct - - dialog - title: DatasetFormat - description: Format of the training dataset. - DatasetPurpose: - type: string - enum: - - post-training/messages - - eval/question-answer - - eval/messages-answer - title: DatasetPurpose - description: Purpose of the dataset. Each purpose has a required input data schema. - EfficiencyConfig: - properties: - enable_activation_checkpointing: - anyOf: - - type: boolean - - type: 'null' - default: false - enable_activation_offloading: - anyOf: - - type: boolean - - type: 'null' - default: false - memory_efficient_fsdp_wrap: - anyOf: - - type: boolean - - type: 'null' - default: false - fsdp_cpu_offload: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - title: EfficiencyConfig - description: Configuration for memory and compute efficiency optimizations. - Errors: - properties: - data: - anyOf: - - items: - $ref: '#/components/schemas/BatchError' - type: array - - type: 'null' - object: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - title: Errors - EvaluateResponse: - properties: - generations: - items: - additionalProperties: true - type: object - type: array - title: Generations - scores: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Scores - type: object - required: - - generations - - scores - title: EvaluateResponse - description: The response from an evaluation. - ExpiresAfter: - properties: - anchor: - type: string - const: created_at - title: Anchor - seconds: - type: integer - maximum: 2592000.0 - minimum: 3600.0 - title: Seconds - type: object - required: - - anchor - - seconds - title: ExpiresAfter - description: |- - Control expiration of uploaded files. - - Params: - - anchor, must be "created_at" - - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) - GreedySamplingStrategy: - properties: - type: - type: string - const: greedy - title: Type - default: greedy - type: object - title: GreedySamplingStrategy - description: Greedy sampling strategy that selects the highest probability token at each step. - HealthInfo: - properties: - status: - $ref: '#/components/schemas/HealthStatus' - type: object - required: - - status - title: HealthInfo - description: Health status information for the service. - HealthStatus: - type: string - enum: - - OK - - Error - - Not Implemented - title: HealthStatus - ImageContentItem-Input: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - ImageContentItem-Output: - properties: - type: - type: string - const: image - title: Type - default: image - image: - $ref: '#/components/schemas/_URLOrData' - type: object - required: - - image - title: ImageContentItem - description: A image content item - InputTokensDetails: - properties: - cached_tokens: - type: integer - title: Cached Tokens - additionalProperties: true - type: object - required: - - cached_tokens - title: InputTokensDetails - Job: - properties: - job_id: - type: string - title: Job Id - status: - $ref: '#/components/schemas/JobStatus' - type: object - required: - - job_id - - status - title: Job - description: A job execution instance with status tracking. - JobStatus: - type: string - enum: - - completed - - in_progress - - failed - - scheduled - - cancelled - title: JobStatus - description: Status of a job execution. - JsonType: - properties: - type: - type: string - const: json - title: Type - default: json - type: object - title: JsonType - description: Parameter type for JSON values. - LLMAsJudgeScoringFnParams: - properties: - type: - type: string - const: llm_as_judge - title: Type - default: llm_as_judge - judge_model: - type: string - title: Judge Model - prompt_template: - anyOf: - - type: string - - type: 'null' - judge_score_regexes: - items: - type: string - type: array - title: Judge Score Regexes - description: Regexes to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - required: - - judge_model - title: LLMAsJudgeScoringFnParams - description: Parameters for LLM-as-judge scoring function configuration. - ListBatchesResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/Batch' - type: array - title: Data - description: List of batch objects - first_id: - anyOf: - - type: string - - type: 'null' - description: ID of the first batch in the list - last_id: - anyOf: - - type: string - - type: 'null' - description: ID of the last batch in the list - has_more: - type: boolean - title: Has More - description: Whether there are more batches available - default: false - type: object - required: - - data - title: ListBatchesResponse - description: Response containing a list of batch objects. - ListBenchmarksResponse: - properties: - data: - items: - $ref: '#/components/schemas/Benchmark' - type: array - title: Data - type: object - required: - - data - title: ListBenchmarksResponse - ListDatasetsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Dataset' - type: array - title: Data - type: object - required: - - data - title: ListDatasetsResponse - description: Response from listing datasets. - ListOpenAIChatCompletionResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAICompletionWithInputMessages' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIChatCompletionResponse - description: Response from listing OpenAI-compatible chat completions. - ListOpenAIFileResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIFileObject' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIFileResponse - description: Response for listing files in OpenAI Files API. - ListOpenAIResponseInputItem: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Data - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - title: ListOpenAIResponseInputItem - description: List container for OpenAI response input items. - ListOpenAIResponseObject: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIResponseObjectWithInput-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - first_id: - type: string - title: First Id - last_id: - type: string - title: Last Id - object: - type: string - const: list - title: Object - default: list - type: object - required: - - data - - has_more - - first_id - - last_id - title: ListOpenAIResponseObject - description: Paginated list of OpenAI response objects with navigation metadata. - ListPostTrainingJobsResponse: - properties: - data: - items: - $ref: '#/components/schemas/PostTrainingJob' - type: array - title: Data - type: object - required: - - data - title: ListPostTrainingJobsResponse - ListPromptsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Prompt' - type: array - title: Data - type: object - required: - - data - title: ListPromptsResponse - description: Response model to list prompts. - ListProvidersResponse: - properties: - data: - items: - $ref: '#/components/schemas/ProviderInfo' - type: array - title: Data - type: object - required: - - data - title: ListProvidersResponse - description: Response containing a list of all available providers. - ListRoutesResponse: - properties: - data: - items: - $ref: '#/components/schemas/RouteInfo' - type: array - title: Data - type: object - required: - - data - title: ListRoutesResponse - description: Response containing a list of all available API routes. - ListScoringFunctionsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ScoringFn' - type: array - title: Data - type: object - required: - - data - title: ListScoringFunctionsResponse - ListShieldsResponse: - properties: - data: - items: - $ref: '#/components/schemas/Shield' - type: array - title: Data - type: object - required: - - data - title: ListShieldsResponse - ListToolDefsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolDef' - type: array - title: Data - type: object - required: - - data - title: ListToolDefsResponse - description: Response containing a list of tool definitions. - ListToolGroupsResponse: - properties: - data: - items: - $ref: '#/components/schemas/ToolGroup' - type: array - title: Data - type: object - required: - - data - title: ListToolGroupsResponse - description: Response containing a list of tool groups. - LoraFinetuningConfig: - properties: - type: - type: string - const: LoRA - title: Type - default: LoRA - lora_attn_modules: - items: - type: string - type: array - title: Lora Attn Modules - apply_lora_to_mlp: - type: boolean - title: Apply Lora To Mlp - apply_lora_to_output: - type: boolean - title: Apply Lora To Output - rank: - type: integer - title: Rank - alpha: - type: integer - title: Alpha - use_dora: - anyOf: - - type: boolean - - type: 'null' - default: false - quantize_base: - anyOf: - - type: boolean - - type: 'null' - default: false - type: object - required: - - lora_attn_modules - - apply_lora_to_mlp - - apply_lora_to_output - - rank - - alpha - title: LoraFinetuningConfig - description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. - MCPListToolsTool: - properties: - input_schema: - additionalProperties: true - type: object - title: Input Schema - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_schema - - name - title: MCPListToolsTool - description: Tool definition returned by MCP list tools operation. - Model: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: model - title: Type - default: model - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this model - model_type: - $ref: '#/components/schemas/ModelType' - default: llm - type: object - required: - - identifier - - provider_id - title: Model - description: A model resource representing an AI model registered in Llama Stack. - ModelCandidate: - properties: - type: - type: string - const: model - title: Type - default: model - model: - type: string - title: Model - sampling_params: - $ref: '#/components/schemas/SamplingParams' - system_message: - anyOf: - - $ref: '#/components/schemas/SystemMessage' - title: SystemMessage - - type: 'null' - title: SystemMessage - type: object - required: - - model - - sampling_params - title: ModelCandidate - description: A model candidate for evaluation. - ModelType: - type: string - enum: - - llm - - embedding - - rerank - title: ModelType - description: Enumeration of supported model types in Llama Stack. - ModerationObject: - properties: - id: - type: string - title: Id - model: - type: string - title: Model - results: - items: - $ref: '#/components/schemas/ModerationObjectResults' - type: array - title: Results - type: object - required: - - id - - model - - results - title: ModerationObject - description: A moderation object. - ModerationObjectResults: - properties: - flagged: - type: boolean - title: Flagged - categories: - anyOf: - - additionalProperties: - type: boolean - type: object - - type: 'null' - category_applied_input_types: - anyOf: - - additionalProperties: - items: - type: string - type: array - type: object - - type: 'null' - category_scores: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - flagged - title: ModerationObjectResults - description: A moderation object. - NumberType: - properties: - type: - type: string - const: number - title: Type - default: number - type: object - title: NumberType - description: Parameter type for numeric values. - ObjectType: - properties: - type: - type: string - const: object - title: Type - default: object - type: object - title: ObjectType - description: Parameter type for object values. - OpenAIAssistantMessageParam-Input: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIAssistantMessageParam-Output: - properties: - role: - type: string - const: assistant - title: Role - default: assistant - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - - type: 'null' - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - tool_calls: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIChatCompletionToolCall' - type: array - - type: 'null' - type: object - title: OpenAIAssistantMessageParam - description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. - OpenAIChatCompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - type: object - required: - - id - - choices - - created - - model - title: OpenAIChatCompletion - description: Response from an OpenAI-compatible chat completion request. - OpenAIChatCompletionContentPartImageParam: - properties: - type: - type: string - const: image_url - title: Type - default: image_url - image_url: - $ref: '#/components/schemas/OpenAIImageURL' - type: object - required: - - image_url - title: OpenAIChatCompletionContentPartImageParam - description: Image content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionContentPartTextParam: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: OpenAIChatCompletionContentPartTextParam - description: Text content part for OpenAI-compatible chat completion messages. - OpenAIChatCompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' - title: OpenAIAssistantMessageParam-Input - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Input' - title: OpenAIUserMessageParam-Input | ... (5 variants) - type: array - minItems: 1 - title: Messages - frequency_penalty: - anyOf: - - type: number - - type: 'null' - function_call: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - functions: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_completion_tokens: - anyOf: - - type: integer - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - parallel_tool_calls: - anyOf: - - type: boolean - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - response_format: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText - - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - title: OpenAIResponseFormatJSONSchema - - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' - title: OpenAIResponseFormatJSONObject - discriminator: - propertyName: type - mapping: - json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' - json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' - text: '#/components/schemas/OpenAIResponseFormatText' - title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - - type: 'null' - title: Response Format - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - tool_choice: - anyOf: - - type: string - - additionalProperties: true - type: object - - type: 'null' - title: string | object - tools: - anyOf: - - items: - additionalProperties: true - type: object - type: array - - type: 'null' - top_logprobs: - anyOf: - - type: integer - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - messages - title: OpenAIChatCompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible chat completion endpoint. - OpenAIChatCompletionToolCall: - properties: - index: - anyOf: - - type: integer - - type: 'null' - id: - anyOf: - - type: string - - type: 'null' - type: - type: string - const: function - title: Type - default: function - function: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' - title: OpenAIChatCompletionToolCallFunction - - type: 'null' - title: OpenAIChatCompletionToolCallFunction - type: object - title: OpenAIChatCompletionToolCall - description: Tool call specification for OpenAI-compatible chat completion responses. - OpenAIChatCompletionToolCallFunction: - properties: - name: - anyOf: - - type: string - - type: 'null' - arguments: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIChatCompletionToolCallFunction - description: Function call details for OpenAI-compatible tool calls. - OpenAIChatCompletionUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - completion_tokens: - type: integer - title: Completion Tokens - total_tokens: - type: integer - title: Total Tokens - prompt_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' - title: OpenAIChatCompletionUsagePromptTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsagePromptTokensDetails - completion_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' - title: OpenAIChatCompletionUsageCompletionTokensDetails - - type: 'null' - title: OpenAIChatCompletionUsageCompletionTokensDetails - type: object - required: - - prompt_tokens - - completion_tokens - - total_tokens - title: OpenAIChatCompletionUsage - description: Usage information for OpenAI chat completion. - OpenAIChatCompletionUsageCompletionTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsageCompletionTokensDetails - description: Token details for output tokens in OpenAI chat completion usage. - OpenAIChatCompletionUsagePromptTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIChatCompletionUsagePromptTokensDetails - description: Token details for prompt tokens in OpenAI chat completion usage. - OpenAIChoice-Output: - properties: - message: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam-Output | ... (5 variants) - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - finish_reason: - type: string - title: Finish Reason - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - message - - finish_reason - - index - title: OpenAIChoice - description: A choice from an OpenAI-compatible chat completion response. - OpenAIChoiceLogprobs-Output: - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - type: object - title: OpenAIChoiceLogprobs - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - OpenAICompletion: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAICompletionChoice-Output' - type: array - title: Choices - created: - type: integer - title: Created - model: - type: string - title: Model - object: - type: string - const: text_completion - title: Object - default: text_completion - type: object - required: - - id - - choices - - created - - model - title: OpenAICompletion - description: |- - Response from an OpenAI-compatible completion request. - - :id: The ID of the completion - :choices: List of choices - :created: The Unix timestamp in seconds when the completion was created - :model: The model that was used to generate the completion - :object: The object type, which will be "text_completion" - OpenAICompletionChoice-Output: - properties: - finish_reason: - type: string - title: Finish Reason - text: - type: string - title: Text - index: - type: integer - title: Index - logprobs: - anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output' - title: OpenAIChoiceLogprobs-Output - - type: 'null' - title: OpenAIChoiceLogprobs-Output - type: object - required: - - finish_reason - - text - - index - title: OpenAICompletionChoice - description: |- - A choice from an OpenAI-compatible completion response. - - :finish_reason: The reason the model stopped generating - :text: The text of the choice - :index: The index of the choice - :logprobs: (Optional) The log probabilities for the tokens in the choice - OpenAICompletionRequestWithExtraBody: - properties: - model: - type: string - title: Model - prompt: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - items: - type: integer - type: array - title: list[integer] - - items: - items: - type: integer - type: array - type: array - title: list[array] - title: string | ... (4 variants) - best_of: - anyOf: - - type: integer - - type: 'null' - echo: - anyOf: - - type: boolean - - type: 'null' - frequency_penalty: - anyOf: - - type: number - - type: 'null' - logit_bias: - anyOf: - - additionalProperties: - type: number - type: object - - type: 'null' - logprobs: - anyOf: - - type: boolean - - type: 'null' - max_tokens: - anyOf: - - type: integer - - type: 'null' - n: - anyOf: - - type: integer - - type: 'null' - presence_penalty: - anyOf: - - type: number - - type: 'null' - seed: - anyOf: - - type: integer - - type: 'null' - stop: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - - type: 'null' - title: string | list[string] - stream: - anyOf: - - type: boolean - - type: 'null' - stream_options: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - temperature: - anyOf: - - type: number - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - suffix: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - prompt - title: OpenAICompletionRequestWithExtraBody - description: Request parameters for OpenAI-compatible completion endpoint. - OpenAICompletionWithInputMessages: - properties: - id: - type: string - title: Id - choices: - items: - $ref: '#/components/schemas/OpenAIChoice-Output' - type: array - title: Choices - object: - type: string - const: chat.completion - title: Object - default: chat.completion - created: - type: integer - title: Created - model: - type: string - title: Model - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIChatCompletionUsage' - title: OpenAIChatCompletionUsage - - type: 'null' - title: OpenAIChatCompletionUsage - input_messages: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' - title: OpenAIAssistantMessageParam-Output - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - discriminator: - propertyName: role - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam-Output' - title: OpenAIUserMessageParam-Output | ... (5 variants) - type: array - title: Input Messages - type: object - required: - - id - - choices - - created - - model - - input_messages - title: OpenAICompletionWithInputMessages - OpenAICreateVectorStoreFileBatchRequestWithExtraBody: - properties: - file_ids: - items: - type: string - type: array - title: File Ids - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - additionalProperties: true - type: object - required: - - file_ids - title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody - description: Request to create a vector store file batch with extra_body support. - OpenAICreateVectorStoreRequestWithExtraBody: - properties: - name: - anyOf: - - type: string - - type: 'null' - file_ids: - anyOf: - - items: - type: string - type: array - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - additionalProperties: true - type: object - title: OpenAICreateVectorStoreRequestWithExtraBody - description: Request to create a vector store with extra_body support. - OpenAIDeleteResponseObject: - properties: - id: - type: string - title: Id - object: - type: string - const: response - title: Object - default: response - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: OpenAIDeleteResponseObject - description: Response object confirming deletion of an OpenAI response. - OpenAIDeveloperMessageParam: - properties: - role: - type: string - const: developer - title: Role - default: developer - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIDeveloperMessageParam - description: A message from the developer in an OpenAI-compatible chat completion request. - OpenAIEmbeddingData: - properties: - object: - type: string - const: embedding - title: Object - default: embedding - embedding: - anyOf: - - items: - type: number - type: array - title: list[number] - - type: string - title: list[number] | string - index: - type: integer - title: Index - type: object - required: - - embedding - - index - title: OpenAIEmbeddingData - description: A single embedding data object from an OpenAI-compatible embeddings response. - OpenAIEmbeddingUsage: - properties: - prompt_tokens: - type: integer - title: Prompt Tokens - total_tokens: - type: integer - title: Total Tokens - type: object - required: - - prompt_tokens - - total_tokens - title: OpenAIEmbeddingUsage - description: Usage information for an OpenAI-compatible embeddings response. - OpenAIEmbeddingsRequestWithExtraBody: - properties: - model: - type: string - title: Model - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - encoding_format: - anyOf: - - type: string - - type: 'null' - default: float - dimensions: - anyOf: - - type: integer - - type: 'null' - user: - anyOf: - - type: string - - type: 'null' - additionalProperties: true - type: object - required: - - model - - input - title: OpenAIEmbeddingsRequestWithExtraBody - description: Request parameters for OpenAI-compatible embeddings endpoint. - OpenAIEmbeddingsResponse: - properties: - object: - type: string - const: list - title: Object - default: list - data: - items: - $ref: '#/components/schemas/OpenAIEmbeddingData' - type: array - title: Data - model: - type: string - title: Model - usage: - $ref: '#/components/schemas/OpenAIEmbeddingUsage' - type: object - required: - - data - - model - - usage - title: OpenAIEmbeddingsResponse - description: Response from an OpenAI-compatible embeddings request. - OpenAIFile: - properties: - type: - type: string - const: file - title: Type - default: file - file: - $ref: '#/components/schemas/OpenAIFileFile' - type: object - required: - - file - title: OpenAIFile - OpenAIFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - const: file - title: Object - default: file - deleted: - type: boolean - title: Deleted - type: object - required: - - id - - deleted - title: OpenAIFileDeleteResponse - description: Response for deleting a file in OpenAI Files API. - OpenAIFileFile: - properties: - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIFileFile - OpenAIFileObject: - properties: - object: - type: string - const: file - title: Object - default: file - id: - type: string - title: Id - bytes: - type: integer - title: Bytes - created_at: - type: integer - title: Created At - expires_at: - type: integer - title: Expires At - filename: - type: string - title: Filename - purpose: - $ref: '#/components/schemas/OpenAIFilePurpose' - type: object - required: - - id - - bytes - - created_at - - expires_at - - filename - - purpose - title: OpenAIFileObject - description: OpenAI File object as defined in the OpenAI Files API. - OpenAIFilePurpose: - type: string - enum: - - assistants - - batch - title: OpenAIFilePurpose - description: Valid purpose values for OpenAI Files API. - OpenAIImageURL: - properties: - url: - type: string - title: Url - detail: - anyOf: - - type: string - - type: 'null' - type: object - required: - - url - title: OpenAIImageURL - description: Image URL specification for OpenAI-compatible chat completion messages. - OpenAIJSONSchema: - properties: - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: OpenAIJSONSchema - description: JSON schema specification for OpenAI-compatible structured response format. - OpenAIListModelsResponse: - properties: - data: - items: - $ref: '#/components/schemas/OpenAIModel' - type: array - title: Data - type: object - required: - - data - title: OpenAIListModelsResponse - OpenAIModel: - properties: - id: - type: string - title: Id - object: - type: string - const: model - title: Object - default: model - created: - type: integer - title: Created - owned_by: - type: string - title: Owned By - custom_metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - id - - created - - owned_by - title: OpenAIModel - description: |- - A model from OpenAI. - - :id: The ID of the model - :object: The object type, which will be "model" - :created: The Unix timestamp in seconds when the model was created - :owned_by: The owner of the model - :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata - OpenAIResponseAnnotationCitation: - properties: - type: - type: string - const: url_citation - title: Type - default: url_citation - end_index: - type: integer - title: End Index - start_index: - type: integer - title: Start Index - title: - type: string - title: Title - url: - type: string - title: Url - type: object - required: - - end_index - - start_index - - title - - url - title: OpenAIResponseAnnotationCitation - description: URL citation annotation for referencing external web resources. - OpenAIResponseAnnotationContainerFileCitation: - properties: - type: - type: string - const: container_file_citation - title: Type - default: container_file_citation - container_id: - type: string - title: Container Id - end_index: - type: integer - title: End Index - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - start_index: - type: integer - title: Start Index - type: object - required: - - container_id - - end_index - - file_id - - filename - - start_index - title: OpenAIResponseAnnotationContainerFileCitation - OpenAIResponseAnnotationFileCitation: - properties: - type: - type: string - const: file_citation - title: Type - default: file_citation - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - index: - type: integer - title: Index - type: object - required: - - file_id - - filename - - index - title: OpenAIResponseAnnotationFileCitation - description: File citation annotation for referencing specific files in response content. - OpenAIResponseAnnotationFilePath: - properties: - type: - type: string - const: file_path - title: Type - default: file_path - file_id: - type: string - title: File Id - index: - type: integer - title: Index - type: object - required: - - file_id - - index - title: OpenAIResponseAnnotationFilePath - OpenAIResponseContentPartRefusal: - properties: - type: - type: string - const: refusal - title: Type - default: refusal - refusal: - type: string - title: Refusal - type: object - required: - - refusal - title: OpenAIResponseContentPartRefusal - description: Refusal content within a streamed response part. - OpenAIResponseError: - properties: - code: - type: string - title: Code - message: - type: string - title: Message - type: object - required: - - code - - message - title: OpenAIResponseError - description: Error details for failed OpenAI response requests. - OpenAIResponseFormatJSONObject: - properties: - type: - type: string - const: json_object - title: Type - default: json_object - type: object - title: OpenAIResponseFormatJSONObject - description: JSON object response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatJSONSchema: - properties: - type: - type: string - const: json_schema - title: Type - default: json_schema - json_schema: - $ref: '#/components/schemas/OpenAIJSONSchema' - type: object - required: - - json_schema - title: OpenAIResponseFormatJSONSchema - description: JSON schema response format for OpenAI-compatible chat completion requests. - OpenAIResponseFormatText: - properties: - type: - type: string - const: text - title: Type - default: text - type: object - title: OpenAIResponseFormatText - description: Text response format for OpenAI-compatible chat completion requests. - OpenAIResponseInputFunctionToolCallOutput: - properties: - call_id: - type: string - title: Call Id - output: - type: string - title: Output - type: - type: string - const: function_call_output - title: Type - default: function_call_output - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - output - title: OpenAIResponseInputFunctionToolCallOutput - description: This represents the output of a function call that gets passed back to the model. - OpenAIResponseInputMessageContentFile: - properties: - type: - type: string - const: input_file - title: Type - default: input_file - file_data: - anyOf: - - type: string - - type: 'null' - file_id: - anyOf: - - type: string - - type: 'null' - file_url: - anyOf: - - type: string - - type: 'null' - filename: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentFile - description: File content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentImage: - properties: - detail: - title: Detail - default: auto - type: string - enum: - - low - - high - - auto - type: - type: string - const: input_image - title: Type - default: input_image - file_id: - anyOf: - - type: string - - type: 'null' - image_url: - anyOf: - - type: string - - type: 'null' - type: object - title: OpenAIResponseInputMessageContentImage - description: Image content for input messages in OpenAI response format. - OpenAIResponseInputMessageContentText: - properties: - text: - type: string - title: Text - type: - type: string - const: input_text - title: Type - default: input_text - type: object - required: - - text - title: OpenAIResponseInputMessageContentText - description: Text content for input messages in OpenAI response format. - OpenAIResponseInputToolFileSearch: - properties: - type: - type: string - const: file_search - title: Type - default: file_search - vector_store_ids: - items: - type: string - type: array - title: Vector Store Ids - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - maximum: 50.0 - minimum: 1.0 - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - type: object - required: - - vector_store_ids - title: OpenAIResponseInputToolFileSearch - description: File search tool configuration for OpenAI response inputs. - OpenAIResponseInputToolFunction: - properties: - type: - type: string - const: function - title: Type - default: function - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - parameters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - required: - - name - - parameters - title: OpenAIResponseInputToolFunction - description: Function tool configuration for OpenAI response inputs. - OpenAIResponseInputToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - server_url: - type: string - title: Server Url - headers: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - require_approval: - anyOf: - - type: string - const: always - - type: string - const: never - - $ref: '#/components/schemas/ApprovalFilter' - title: ApprovalFilter - title: string | ApprovalFilter - default: never - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - - server_url - title: OpenAIResponseInputToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. - OpenAIResponseInputToolWebSearch: - properties: - type: - title: Type - default: web_search - type: string - enum: - - web_search - - web_search_preview - - web_search_preview_2025_03_11 - - web_search_2025_08_26 - search_context_size: - anyOf: - - type: string - pattern: ^low|medium|high$ - - type: 'null' - default: medium - type: object - title: OpenAIResponseInputToolWebSearch - description: Web search tool configuration for OpenAI response inputs. - OpenAIResponseMCPApprovalRequest: - properties: - arguments: - type: string - title: Arguments - id: - type: string - title: Id - name: - type: string - title: Name - server_label: - type: string - title: Server Label - type: - type: string - const: mcp_approval_request - title: Type - default: mcp_approval_request - type: object - required: - - arguments - - id - - name - - server_label - title: OpenAIResponseMCPApprovalRequest - description: A request for human approval of a tool invocation. - OpenAIResponseMCPApprovalResponse: - properties: - approval_request_id: - type: string - title: Approval Request Id - approve: - type: boolean - title: Approve - type: - type: string - const: mcp_approval_response - title: Type - default: mcp_approval_response - id: - anyOf: - - type: string - - type: 'null' - reason: - anyOf: - - type: string - - type: 'null' - type: object - required: - - approval_request_id - - approve - title: OpenAIResponseMCPApprovalResponse - description: A response to an MCP approval request. - OpenAIResponseMessage-Input: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseMessage-Output: - properties: - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: array - title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - title: OpenAIResponseOutputMessageContentOutputText - - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseContentPartRefusal - discriminator: - propertyName: type - mapping: - output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' - title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal - type: array - title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] - role: - title: Role - type: string - enum: - - system - - developer - - user - - assistant - default: system - type: - type: string - const: message - title: Type - default: message - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - - role - title: OpenAIResponseMessage - description: |- - Corresponds to the various Message types in the Responses API. - They are all under one type because the Responses API gives them all - the same "type" value, and there is no way to tell them apart in certain - scenarios. - OpenAIResponseObject: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - created_at - - id - - model - - output - - status - title: OpenAIResponseObject - description: Complete OpenAI response object containing generation results and metadata. - OpenAIResponseObjectWithInput-Output: - properties: - created_at: - type: integer - title: Created At - error: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseError' - title: OpenAIResponseError - - type: 'null' - title: OpenAIResponseError - id: - type: string - title: Id - model: - type: string - title: Model - object: - type: string - const: response - title: Object - default: response - output: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Output | ... (7 variants) - type: array - title: Output - parallel_tool_calls: - type: boolean - title: Parallel Tool Calls - default: false - previous_response_id: - anyOf: - - type: string - - type: 'null' - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - status: - type: string - title: Status - temperature: - anyOf: - - type: number - - type: 'null' - text: - $ref: '#/components/schemas/OpenAIResponseText' - default: - format: - type: text - top_p: - anyOf: - - type: number - - type: 'null' - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseToolMCP' - title: OpenAIResponseToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - truncation: - anyOf: - - type: string - - type: 'null' - usage: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsage' - title: OpenAIResponseUsage - - type: 'null' - title: OpenAIResponseUsage - instructions: - anyOf: - - type: string - - type: 'null' - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - input: - items: - $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' - type: array - title: Input - type: object - required: - - created_at - - id - - model - - output - - status - - input - title: OpenAIResponseObjectWithInput - description: OpenAI response object extended with input context information. - OpenAIResponseOutputMessageContentOutputText: - properties: - text: - type: string - title: Text - type: - type: string - const: output_text - title: Type - default: output_text - annotations: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - title: OpenAIResponseAnnotationFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - title: OpenAIResponseAnnotationContainerFileCitation - - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - title: OpenAIResponseAnnotationFilePath - discriminator: - propertyName: type - mapping: - container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' - url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' - title: OpenAIResponseAnnotationFileCitation | ... (4 variants) - type: array - title: Annotations - type: object - required: - - text - title: OpenAIResponseOutputMessageContentOutputText - OpenAIResponseOutputMessageFileSearchToolCall: - properties: - id: - type: string - title: Id - queries: - items: - type: string - type: array - title: Queries - status: - type: string - title: Status - type: - type: string - const: file_search_call - title: Type - default: file_search_call - results: - anyOf: - - items: - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' - type: array - - type: 'null' - type: object - required: - - id - - queries - - status - title: OpenAIResponseOutputMessageFileSearchToolCall - description: File search tool call output message for OpenAI responses. - OpenAIResponseOutputMessageFileSearchToolCallResults: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - text: - type: string - title: Text - type: object - required: - - attributes - - file_id - - filename - - score - - text - title: OpenAIResponseOutputMessageFileSearchToolCallResults - description: Search results returned by the file search operation. - OpenAIResponseOutputMessageFunctionToolCall: - properties: - call_id: - type: string - title: Call Id - name: - type: string - title: Name - arguments: - type: string - title: Arguments - type: - type: string - const: function_call - title: Type - default: function_call - id: - anyOf: - - type: string - - type: 'null' - status: - anyOf: - - type: string - - type: 'null' - type: object - required: - - call_id - - name - - arguments - title: OpenAIResponseOutputMessageFunctionToolCall - description: Function tool call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPCall: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_call - title: Type - default: mcp_call - arguments: - type: string - title: Arguments - name: - type: string - title: Name - server_label: - type: string - title: Server Label - error: - anyOf: - - type: string - - type: 'null' - output: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - - arguments - - name - - server_label - title: OpenAIResponseOutputMessageMCPCall - description: Model Context Protocol (MCP) call output message for OpenAI responses. - OpenAIResponseOutputMessageMCPListTools: - properties: - id: - type: string - title: Id - type: - type: string - const: mcp_list_tools - title: Type - default: mcp_list_tools - server_label: - type: string - title: Server Label - tools: - items: - $ref: '#/components/schemas/MCPListToolsTool' - type: array - title: Tools - type: object - required: - - id - - server_label - - tools - title: OpenAIResponseOutputMessageMCPListTools - description: MCP list tools output message containing available tools from an MCP server. - OpenAIResponseOutputMessageWebSearchToolCall: - properties: - id: - type: string - title: Id - status: - type: string - title: Status - type: - type: string - const: web_search_call - title: Type - default: web_search_call - type: object - required: - - id - - status - title: OpenAIResponseOutputMessageWebSearchToolCall - description: Web search tool call output message for OpenAI responses. - OpenAIResponsePrompt: - properties: - id: - type: string - title: Id - variables: - anyOf: - - additionalProperties: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' - title: OpenAIResponseInputMessageContentImage - - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' - title: OpenAIResponseInputMessageContentFile - discriminator: - propertyName: type - mapping: - input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' - input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' - input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' - title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile - type: object - - type: 'null' - version: - anyOf: - - type: string - - type: 'null' - type: object - required: - - id - title: OpenAIResponsePrompt - description: OpenAI compatible Prompt object that is used in OpenAI responses. - OpenAIResponseText: - properties: - format: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseTextFormat' - title: OpenAIResponseTextFormat - - type: 'null' - title: OpenAIResponseTextFormat - type: object - title: OpenAIResponseText - description: Text response configuration for OpenAI responses. - OpenAIResponseTextFormat: - properties: - type: - title: Type - type: string - enum: - - text - - json_schema - - json_object - default: text - name: - anyOf: - - type: string - - type: 'null' - schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - description: - anyOf: - - type: string - - type: 'null' - strict: - anyOf: - - type: boolean - - type: 'null' - type: object - title: OpenAIResponseTextFormat - description: Configuration for Responses API text format. - OpenAIResponseToolMCP: - properties: - type: - type: string - const: mcp - title: Type - default: mcp - server_label: - type: string - title: Server Label - allowed_tools: - anyOf: - - items: - type: string - type: array - title: list[string] - - $ref: '#/components/schemas/AllowedToolsFilter' - title: AllowedToolsFilter - - type: 'null' - title: list[string] | AllowedToolsFilter - type: object - required: - - server_label - title: OpenAIResponseToolMCP - description: Model Context Protocol (MCP) tool configuration for OpenAI response object. - OpenAIResponseUsage: - properties: - input_tokens: - type: integer - title: Input Tokens - output_tokens: - type: integer - title: Output Tokens - total_tokens: - type: integer - title: Total Tokens - input_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' - title: OpenAIResponseUsageInputTokensDetails - - type: 'null' - title: OpenAIResponseUsageInputTokensDetails - output_tokens_details: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' - title: OpenAIResponseUsageOutputTokensDetails - - type: 'null' - title: OpenAIResponseUsageOutputTokensDetails - type: object - required: - - input_tokens - - output_tokens - - total_tokens - title: OpenAIResponseUsage - description: Usage information for OpenAI response. - OpenAIResponseUsageInputTokensDetails: - properties: - cached_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageInputTokensDetails - description: Token details for input tokens in OpenAI response usage. - OpenAIResponseUsageOutputTokensDetails: - properties: - reasoning_tokens: - anyOf: - - type: integer - - type: 'null' - type: object - title: OpenAIResponseUsageOutputTokensDetails - description: Token details for output tokens in OpenAI response usage. - OpenAISystemMessageParam: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAISystemMessageParam - description: A system message providing instructions or context to the model. - OpenAITokenLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - top_logprobs: - items: - $ref: '#/components/schemas/OpenAITopLogProb' - type: array - title: Top Logprobs - type: object - required: - - token - - logprob - - top_logprobs - title: OpenAITokenLogProb - description: |- - The log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - :top_logprobs: The top log probabilities for the token - OpenAIToolMessageParam: - properties: - role: - type: string - const: tool - title: Role - default: tool - tool_call_id: - type: string - title: Tool Call Id - content: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - type: array - title: list[OpenAIChatCompletionContentPartTextParam] - title: string | list[OpenAIChatCompletionContentPartTextParam] - type: object - required: - - tool_call_id - - content - title: OpenAIToolMessageParam - description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. - OpenAITopLogProb: - properties: - token: - type: string - title: Token - bytes: - anyOf: - - items: - type: integer - type: array - - type: 'null' - logprob: - type: number - title: Logprob - type: object - required: - - token - - logprob - title: OpenAITopLogProb - description: |- - The top log probability for a token from an OpenAI-compatible chat completion response. - - :token: The token - :bytes: (Optional) The bytes for the token - :logprob: The log probability of the token - OpenAIUserMessageParam-Input: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OpenAIUserMessageParam-Output: - properties: - role: - type: string - const: user - title: Role - default: user - content: - anyOf: - - type: string - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - - $ref: '#/components/schemas/OpenAIFile' - title: OpenAIFile - discriminator: - propertyName: type - mapping: - file: '#/components/schemas/OpenAIFile' - image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile - type: array - title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] - name: - anyOf: - - type: string - - type: 'null' - type: object - required: - - content - title: OpenAIUserMessageParam - description: A message from the user in an OpenAI-compatible chat completion request. - OptimizerConfig: - properties: - optimizer_type: - $ref: '#/components/schemas/OptimizerType' - lr: - type: number - title: Lr - weight_decay: - type: number - title: Weight Decay - num_warmup_steps: - type: integer - title: Num Warmup Steps - type: object - required: - - optimizer_type - - lr - - weight_decay - - num_warmup_steps - title: OptimizerConfig - description: Configuration parameters for the optimization algorithm. - OptimizerType: - type: string - enum: - - adam - - adamw - - sgd - title: OptimizerType - description: Available optimizer algorithms for training. - Order: - type: string - enum: - - asc - - desc - title: Order - description: Sort order for paginated responses. - OutputTokensDetails: - properties: - reasoning_tokens: - type: integer - title: Reasoning Tokens - additionalProperties: true - type: object - required: - - reasoning_tokens - title: OutputTokensDetails - PaginatedResponse: - properties: - data: - items: - additionalProperties: true - type: object - type: array - title: Data - has_more: - type: boolean - title: Has More - url: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - - has_more - title: PaginatedResponse - description: A generic paginated response that follows a simple format. - PostTrainingJob: - properties: - job_uuid: - type: string - title: Job Uuid - type: object - required: - - job_uuid - title: PostTrainingJob - PostTrainingJobArtifactsResponse: - properties: - job_uuid: - type: string - title: Job Uuid - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - title: PostTrainingJobArtifactsResponse - description: Artifacts of a finetuning job. - PostTrainingJobStatusResponse: - properties: - job_uuid: - type: string - title: Job Uuid - status: - $ref: '#/components/schemas/JobStatus' - scheduled_at: - anyOf: - - type: string - format: date-time - - type: 'null' - started_at: - anyOf: - - type: string - format: date-time - - type: 'null' - completed_at: - anyOf: - - type: string - format: date-time - - type: 'null' - resources_allocated: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - checkpoints: - items: - $ref: '#/components/schemas/Checkpoint' - type: array - title: Checkpoints - type: object - required: - - job_uuid - - status - title: PostTrainingJobStatusResponse - description: Status of a finetuning job. - PostTrainingMetric: - properties: - epoch: - type: integer - title: Epoch - train_loss: - type: number - title: Train Loss - validation_loss: - type: number - title: Validation Loss - perplexity: - type: number - title: Perplexity - type: object - required: - - epoch - - train_loss - - validation_loss - - perplexity - title: PostTrainingMetric - description: Training metrics captured during post-training jobs. - Prompt: - properties: - prompt: - anyOf: - - type: string - - type: 'null' - description: The system prompt with variable placeholders - version: - type: integer - minimum: 1.0 - title: Version - description: Version (integer starting at 1, incremented on save) - prompt_id: - type: string - title: Prompt Id - description: Unique identifier in format 'pmpt_<48-digit-hash>' - variables: - items: - type: string - type: array - title: Variables - description: List of variable names that can be used in the prompt template - is_default: - type: boolean - title: Is Default - description: Boolean indicating whether this version is the default version - default: false - type: object - required: - - version - - prompt_id - title: Prompt - description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. - ProviderInfo: - properties: - api: - type: string - title: Api - provider_id: - type: string - title: Provider Id - provider_type: - type: string - title: Provider Type - config: - additionalProperties: true - type: object - title: Config - health: - additionalProperties: true - type: object - title: Health - type: object - required: - - api - - provider_id - - provider_type - - config - - health - title: ProviderInfo - description: Information about a registered provider including its configuration and health status. - QATFinetuningConfig: - properties: - type: - type: string - const: QAT - title: Type - default: QAT - quantizer_name: - type: string - title: Quantizer Name - group_size: - type: integer - title: Group Size - type: object - required: - - quantizer_name - - group_size - title: QATFinetuningConfig - description: Configuration for Quantization-Aware Training (QAT) fine-tuning. - QueryChunksResponse: - properties: - chunks: - items: - $ref: '#/components/schemas/Chunk-Output' - type: array - title: Chunks - scores: - items: - type: number - type: array - title: Scores - type: object - required: - - chunks - - scores - title: QueryChunksResponse - description: Response from querying chunks in a vector database. - RegexParserScoringFnParams: - properties: - type: - type: string - const: regex_parser - title: Type - default: regex_parser - parsing_regexes: - items: - type: string - type: array - title: Parsing Regexes - description: Regex to extract the answer from generated response - aggregation_functions: - items: - $ref: '#/components/schemas/AggregationFunctionType' - type: array - title: Aggregation Functions - description: Aggregation functions to apply to the scores of each row - type: object - title: RegexParserScoringFnParams - description: Parameters for regex parser scoring function configuration. - RerankData: - properties: - index: - type: integer - title: Index - relevance_score: - type: number - title: Relevance Score - type: object - required: - - index - - relevance_score - title: RerankData - description: A single rerank result from a reranking response. - RerankResponse: - properties: - data: - items: - $ref: '#/components/schemas/RerankData' - type: array - title: Data - type: object - required: - - data - title: RerankResponse - description: Response from a reranking request. - RouteInfo: - properties: - route: - type: string - title: Route - method: - type: string - title: Method - provider_types: - items: - type: string - type: array - title: Provider Types - type: object - required: - - route - - method - - provider_types - title: RouteInfo - description: Information about an API route including its path, method, and implementing providers. - RowsDataSource: - properties: - type: - type: string - const: rows - title: Type - default: rows - rows: - items: - additionalProperties: true - type: object - type: array - title: Rows - type: object - required: - - rows - title: RowsDataSource - description: A dataset stored in rows. - RunShieldResponse: - properties: - violation: - anyOf: - - $ref: '#/components/schemas/SafetyViolation' - title: SafetyViolation - - type: 'null' - title: SafetyViolation - type: object - title: RunShieldResponse - description: Response from running a safety shield. - SafetyViolation: - properties: - violation_level: - $ref: '#/components/schemas/ViolationLevel' - user_message: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - violation_level - title: SafetyViolation - description: Details of a safety violation detected by content moderation. - SamplingParams: - properties: - strategy: - oneOf: - - $ref: '#/components/schemas/GreedySamplingStrategy' - title: GreedySamplingStrategy - - $ref: '#/components/schemas/TopPSamplingStrategy' - title: TopPSamplingStrategy - - $ref: '#/components/schemas/TopKSamplingStrategy' - title: TopKSamplingStrategy - title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy - discriminator: - propertyName: type - mapping: - greedy: '#/components/schemas/GreedySamplingStrategy' - top_k: '#/components/schemas/TopKSamplingStrategy' - top_p: '#/components/schemas/TopPSamplingStrategy' - max_tokens: - anyOf: - - type: integer - - type: 'null' - repetition_penalty: - anyOf: - - type: number - - type: 'null' - default: 1.0 - stop: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - title: SamplingParams - description: Sampling parameters. - ScoreBatchResponse: - properties: - dataset_id: - anyOf: - - type: string - - type: 'null' - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreBatchResponse - description: Response from batch scoring operations on datasets. - ScoreResponse: - properties: - results: - additionalProperties: - $ref: '#/components/schemas/ScoringResult' - type: object - title: Results - type: object - required: - - results - title: ScoreResponse - description: The response from scoring. - ScoringFn: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: scoring_function - title: Type - default: scoring_function - description: - anyOf: - - type: string - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - description: Any additional metadata for this definition - return_type: - oneOf: - - $ref: '#/components/schemas/StringType' - title: StringType - - $ref: '#/components/schemas/NumberType' - title: NumberType - - $ref: '#/components/schemas/BooleanType' - title: BooleanType - - $ref: '#/components/schemas/ArrayType' - title: ArrayType - - $ref: '#/components/schemas/ObjectType' - title: ObjectType - - $ref: '#/components/schemas/JsonType' - title: JsonType - - $ref: '#/components/schemas/UnionType' - title: UnionType - - $ref: '#/components/schemas/ChatCompletionInputType' - title: ChatCompletionInputType - - $ref: '#/components/schemas/CompletionInputType' - title: CompletionInputType - title: StringType | ... (9 variants) - description: The return type of the deterministic function - discriminator: - propertyName: type - mapping: - array: '#/components/schemas/ArrayType' - boolean: '#/components/schemas/BooleanType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - json: '#/components/schemas/JsonType' - number: '#/components/schemas/NumberType' - object: '#/components/schemas/ObjectType' - string: '#/components/schemas/StringType' - union: '#/components/schemas/UnionType' - params: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: Params - description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval - type: object - required: - - identifier - - provider_id - - return_type - title: ScoringFn - description: A scoring function resource for evaluating model outputs. - ScoringResult: - properties: - score_rows: - items: - additionalProperties: true - type: object - type: array - title: Score Rows - aggregated_results: - additionalProperties: true - type: object - title: Aggregated Results - type: object - required: - - score_rows - - aggregated_results - title: ScoringResult - description: A scoring result for a single row. - SearchRankingOptions: - properties: - ranker: - anyOf: - - type: string - - type: 'null' - score_threshold: - anyOf: - - type: number - - type: 'null' - default: 0.0 - type: object - title: SearchRankingOptions - description: Options for ranking and filtering search results. - Shield: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: shield - title: Type - default: shield - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: Shield - description: A safety shield resource that can be used to check content. - StringType: - properties: - type: - type: string - const: string - title: Type - default: string - type: object - title: StringType - description: Parameter type for string values. - SystemMessage: - properties: - role: - type: string - const: system - title: Role - default: system - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - type: object - required: - - content - title: SystemMessage - description: A system message providing instructions or context to the model. - TextContentItem: - properties: - type: - type: string - const: text - title: Type - default: text - text: - type: string - title: Text - type: object - required: - - text - title: TextContentItem - description: A text content item - ToolDef: - properties: - toolgroup_id: - anyOf: - - type: string - - type: 'null' - name: - type: string - title: Name - description: - anyOf: - - type: string - - type: 'null' - input_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - output_schema: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - name - title: ToolDef - description: Tool definition used in runtime contexts. - ToolGroup: - properties: - identifier: - type: string - title: Identifier - description: Unique identifier for this resource in llama stack - provider_resource_id: - anyOf: - - type: string - - type: 'null' - description: Unique identifier for this resource in the provider - provider_id: - type: string - title: Provider Id - description: ID of the provider that owns this resource - type: - type: string - const: tool_group - title: Type - default: tool_group - mcp_endpoint: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - args: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - identifier - - provider_id - title: ToolGroup - description: A group of related tools managed together. - ToolInvocationResult: - properties: - content: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Output' - title: ImageContentItem-Output - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Output' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Output | TextContentItem - type: array - title: list[ImageContentItem-Output | TextContentItem] - - type: 'null' - title: string | list[ImageContentItem-Output | TextContentItem] - error_message: - anyOf: - - type: string - - type: 'null' - error_code: - anyOf: - - type: integer - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: ToolInvocationResult - description: Result of a tool invocation. - TopKSamplingStrategy: - properties: - type: - type: string - const: top_k - title: Type - default: top_k - top_k: - type: integer - minimum: 1.0 - title: Top K - type: object - required: - - top_k - title: TopKSamplingStrategy - description: Top-k sampling strategy that restricts sampling to the k most likely tokens. - TopPSamplingStrategy: - properties: - type: - type: string - const: top_p - title: Type - default: top_p - temperature: - anyOf: - - type: number - minimum: 0.0 - - type: 'null' - top_p: - anyOf: - - type: number - - type: 'null' - default: 0.95 - type: object - required: - - temperature - title: TopPSamplingStrategy - description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. - TrainingConfig: - properties: - n_epochs: - type: integer - title: N Epochs - max_steps_per_epoch: - type: integer - title: Max Steps Per Epoch - default: 1 - gradient_accumulation_steps: - type: integer - title: Gradient Accumulation Steps - default: 1 - max_validation_steps: - anyOf: - - type: integer - - type: 'null' - default: 1 - data_config: - anyOf: - - $ref: '#/components/schemas/DataConfig' - title: DataConfig - - type: 'null' - title: DataConfig - optimizer_config: - anyOf: - - $ref: '#/components/schemas/OptimizerConfig' - title: OptimizerConfig - - type: 'null' - title: OptimizerConfig - efficiency_config: - anyOf: - - $ref: '#/components/schemas/EfficiencyConfig' - title: EfficiencyConfig - - type: 'null' - title: EfficiencyConfig - dtype: - anyOf: - - type: string - - type: 'null' - default: bf16 - type: object - required: - - n_epochs - title: TrainingConfig - description: Comprehensive configuration for the training process. - URIDataSource: - properties: - type: - type: string - const: uri - title: Type - default: uri - uri: - type: string - title: Uri - type: object - required: - - uri - title: URIDataSource - description: A dataset that can be obtained from a URI. - URL: - properties: - uri: - type: string - title: Uri - type: object - required: - - uri - title: URL - description: A URL reference to external content. - UnionType: - properties: - type: - type: string - const: union - title: Type - default: union - type: object - title: UnionType - description: Parameter type for union values. - VectorStoreChunkingStrategyAuto: - properties: - type: - type: string - const: auto - title: Type - default: auto - type: object - title: VectorStoreChunkingStrategyAuto - description: Automatic chunking strategy for vector store files. - VectorStoreChunkingStrategyStatic: - properties: - type: - type: string - const: static - title: Type - default: static - static: - $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' - type: object - required: - - static - title: VectorStoreChunkingStrategyStatic - description: Static chunking strategy with configurable parameters. - VectorStoreChunkingStrategyStaticConfig: - properties: - chunk_overlap_tokens: - type: integer - title: Chunk Overlap Tokens - default: 400 - max_chunk_size_tokens: - type: integer - maximum: 4096.0 - minimum: 100.0 - title: Max Chunk Size Tokens - default: 800 - type: object - title: VectorStoreChunkingStrategyStaticConfig - description: Configuration for static chunking strategy. - VectorStoreContent: - properties: - type: - type: string - const: text - title: Type - text: - type: string - title: Text - embedding: - anyOf: - - items: - type: number - type: array - - type: 'null' - chunk_metadata: - anyOf: - - $ref: '#/components/schemas/ChunkMetadata' - title: ChunkMetadata - - type: 'null' - title: ChunkMetadata - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - type - - text - title: VectorStoreContent - description: Content item from a vector store file or search result. - VectorStoreDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreDeleteResponse - description: Response from deleting a vector store. - VectorStoreFileBatchObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file_batch - created_at: - type: integer - title: Created At - vector_store_id: - type: string - title: Vector Store Id - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - type: object - required: - - id - - created_at - - vector_store_id - - status - - file_counts - title: VectorStoreFileBatchObject - description: OpenAI Vector Store File Batch object. - VectorStoreFileContentResponse: - properties: - object: - type: string - const: vector_store.file_content.page - title: Object - default: vector_store.file_content.page - data: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - data - title: VectorStoreFileContentResponse - description: Represents the parsed content of a vector store file. - VectorStoreFileCounts: - properties: - completed: - type: integer - title: Completed - cancelled: - type: integer - title: Cancelled - failed: - type: integer - title: Failed - in_progress: - type: integer - title: In Progress - total: - type: integer - title: Total - type: object - required: - - completed - - cancelled - - failed - - in_progress - - total - title: VectorStoreFileCounts - description: File processing status counts for a vector store. - VectorStoreFileDeleteResponse: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file.deleted - deleted: - type: boolean - title: Deleted - default: true - type: object - required: - - id - title: VectorStoreFileDeleteResponse - description: Response from deleting a vector store file. - VectorStoreFileLastError: - properties: - code: - title: Code - type: string - enum: - - server_error - - rate_limit_exceeded - default: server_error - message: - type: string - title: Message - type: object - required: - - code - - message - title: VectorStoreFileLastError - description: Error information for failed vector store file processing. - VectorStoreFileObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store.file - attributes: - additionalProperties: true - type: object - title: Attributes - chunking_strategy: - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - created_at: - type: integer - title: Created At - last_error: - anyOf: - - $ref: '#/components/schemas/VectorStoreFileLastError' - title: VectorStoreFileLastError - - type: 'null' - title: VectorStoreFileLastError - status: - title: Status - type: string - enum: - - completed - - in_progress - - cancelled - - failed - default: completed - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - vector_store_id: - type: string - title: Vector Store Id - type: object - required: - - id - - chunking_strategy - - created_at - - status - - vector_store_id - title: VectorStoreFileObject - description: OpenAI Vector Store File object. - VectorStoreFilesListInBatchResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreFilesListInBatchResponse - description: Response from listing files in a vector store file batch. - VectorStoreListFilesResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreFileObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListFilesResponse - description: Response from listing files in a vector store. - VectorStoreListResponse: - properties: - object: - type: string - title: Object - default: list - data: - items: - $ref: '#/components/schemas/VectorStoreObject' - type: array - title: Data - first_id: - anyOf: - - type: string - - type: 'null' - last_id: - anyOf: - - type: string - - type: 'null' - has_more: - type: boolean - title: Has More - default: false - type: object - required: - - data - title: VectorStoreListResponse - description: Response from listing vector stores. - VectorStoreObject: - properties: - id: - type: string - title: Id - object: - type: string - title: Object - default: vector_store - created_at: - type: integer - title: Created At - name: - anyOf: - - type: string - - type: 'null' - usage_bytes: - type: integer - title: Usage Bytes - default: 0 - file_counts: - $ref: '#/components/schemas/VectorStoreFileCounts' - status: - type: string - title: Status - default: completed - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - expires_at: - anyOf: - - type: integer - - type: 'null' - last_active_at: - anyOf: - - type: integer - - type: 'null' - metadata: - additionalProperties: true - type: object - title: Metadata - type: object - required: - - id - - created_at - - file_counts - title: VectorStoreObject - description: OpenAI Vector Store object. - VectorStoreSearchResponse-Output: - properties: - file_id: - type: string - title: File Id - filename: - type: string - title: Filename - score: - type: number - title: Score - attributes: - anyOf: - - additionalProperties: - anyOf: - - type: string - - type: number - - type: boolean - title: string | number | boolean - type: object - - type: 'null' - content: - items: - $ref: '#/components/schemas/VectorStoreContent' - type: array - title: Content - type: object - required: - - file_id - - filename - - score - - content - title: VectorStoreSearchResponse - description: Response from searching a vector store. - VectorStoreSearchResponsePage: - properties: - object: - type: string - title: Object - default: vector_store.search_results.page - search_query: - items: - type: string - type: array - title: Search Query - data: - items: - $ref: '#/components/schemas/VectorStoreSearchResponse-Output' - type: array - title: Data - has_more: - type: boolean - title: Has More - default: false - next_page: - anyOf: - - type: string - - type: 'null' - type: object - required: - - search_query - - data - title: VectorStoreSearchResponsePage - description: Paginated response from searching a vector store. - VersionInfo: - properties: - version: - type: string - title: Version - type: object - required: - - version - title: VersionInfo - description: Version information for the service. - ViolationLevel: - type: string - enum: - - info - - warn - - error - title: ViolationLevel - description: Severity level of a safety violation. - _URLOrData: - properties: - url: - anyOf: - - $ref: '#/components/schemas/URL' - title: URL - - type: 'null' - title: URL - data: - anyOf: - - type: string - - type: 'null' - contentEncoding: base64 - type: object - title: _URLOrData - description: A URL or a base64 encoded string - _batches_Request: - properties: - input_file_id: - type: string - title: Input File Id - endpoint: - type: string - title: Endpoint - completion_window: - type: string - const: 24h - title: Completion Window - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - idempotency_key: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input_file_id - - endpoint - - completion_window - title: _batches_Request - _conversations_Request: - properties: - items: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - - type: 'null' - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - type: 'null' - type: object - title: _conversations_Request - _conversations_conversation_id_Request: - properties: - metadata: - additionalProperties: - type: string - type: object - title: Metadata - type: object - required: - - metadata - title: _conversations_conversation_id_Request - _conversations_conversation_id_items_Request: - properties: - items: - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseMessage-Input | ... (9 variants) - type: array - title: Items - type: object - required: - - items - title: _conversations_conversation_id_items_Request - _eval_benchmarks_benchmark_id_evaluations_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - items: - type: string - type: array - title: Scoring Functions - benchmark_config: - $ref: '#/components/schemas/BenchmarkConfig' - type: object - required: - - input_rows - - scoring_functions - - benchmark_config - title: _eval_benchmarks_benchmark_id_evaluations_Request - _inference_rerank_Request: - properties: - model: - type: string - title: Model - query: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - items: - items: - anyOf: - - type: string - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - title: OpenAIChatCompletionContentPartTextParam - - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - title: OpenAIChatCompletionContentPartImageParam - title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam - type: array - title: Items - max_num_results: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - model - - query - - items - title: _inference_rerank_Request - _moderations_Request: - properties: - input: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - model: - anyOf: - - type: string - - type: 'null' - type: object - required: - - input - title: _moderations_Request - _post_training_preference_optimize_Request: - properties: - job_uuid: - type: string - title: Job Uuid - finetuned_model: - type: string - title: Finetuned Model - algorithm_config: - $ref: '#/components/schemas/DPOAlignmentConfig' - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - type: object - required: - - job_uuid - - finetuned_model - - algorithm_config - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_preference_optimize_Request - _post_training_supervised_fine_tune_Request: - properties: - job_uuid: - type: string - title: Job Uuid - training_config: - $ref: '#/components/schemas/TrainingConfig' - hyperparam_search_config: - additionalProperties: true - type: object - title: Hyperparam Search Config - logger_config: - additionalProperties: true - type: object - title: Logger Config - model: - anyOf: - - type: string - - type: 'null' - description: Model descriptor for training if not in provider config` - checkpoint_dir: - anyOf: - - type: string - - type: 'null' - algorithm_config: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LoraFinetuningConfig' - title: LoraFinetuningConfig - - $ref: '#/components/schemas/QATFinetuningConfig' - title: QATFinetuningConfig - discriminator: - propertyName: type - mapping: - LoRA: '#/components/schemas/LoraFinetuningConfig' - QAT: '#/components/schemas/QATFinetuningConfig' - title: LoraFinetuningConfig | QATFinetuningConfig - - type: 'null' - title: Algorithm Config - type: object - required: - - job_uuid - - training_config - - hyperparam_search_config - - logger_config - title: _post_training_supervised_fine_tune_Request - _prompts_Request: - properties: - prompt: - type: string - title: Prompt - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - type: object - required: - - prompt - title: _prompts_Request - _prompts_prompt_id_Request: - properties: - prompt: - type: string - title: Prompt - version: - type: integer - title: Version - variables: - anyOf: - - items: - type: string - type: array - - type: 'null' - set_as_default: - type: boolean - title: Set As Default - default: true - type: object - required: - - prompt - - version - title: _prompts_prompt_id_Request - _prompts_prompt_id_set_default_version_Request: - properties: - version: - type: integer - title: Version - type: object - required: - - version - title: _prompts_prompt_id_set_default_version_Request - _responses_Request: - properties: - input: - anyOf: - - type: string - - items: - $ref: '#/components/schemas/OpenAIResponseMessageInputUnion' - type: array - title: list[OpenAIResponseMessageInputUnion] - title: string | list[OpenAIResponseMessageInputUnion] - model: - type: string - title: Model - prompt: - anyOf: - - $ref: '#/components/schemas/OpenAIResponsePrompt' - title: OpenAIResponsePrompt - - type: 'null' - title: OpenAIResponsePrompt - instructions: - anyOf: - - type: string - - type: 'null' - previous_response_id: - anyOf: - - type: string - - type: 'null' - conversation: - anyOf: - - type: string - - type: 'null' - store: - anyOf: - - type: boolean - - type: 'null' - default: true - stream: - anyOf: - - type: boolean - - type: 'null' - default: false - temperature: - anyOf: - - type: number - - type: 'null' - text: - anyOf: - - $ref: '#/components/schemas/OpenAIResponseText' - title: OpenAIResponseText - - type: 'null' - title: OpenAIResponseText - tools: - anyOf: - - items: - oneOf: - - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - title: OpenAIResponseInputToolFileSearch - - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - title: OpenAIResponseInputToolFunction - - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' - title: OpenAIResponseInputToolMCP - discriminator: - propertyName: type - mapping: - file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' - function: '#/components/schemas/OpenAIResponseInputToolFunction' - mcp: '#/components/schemas/OpenAIResponseInputToolMCP' - web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' - web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' - title: OpenAIResponseInputToolWebSearch | ... (4 variants) - type: array - - type: 'null' - include: - anyOf: - - items: - type: string - type: array - - type: 'null' - max_infer_iters: - anyOf: - - type: integer - - type: 'null' - default: 10 - max_tool_calls: - anyOf: - - type: integer - - type: 'null' - type: object - required: - - input - - model - title: _responses_Request - _scoring_score_Request: - properties: - input_rows: - items: - additionalProperties: true - type: object - type: array - title: Input Rows - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - type: object - required: - - input_rows - - scoring_functions - title: _scoring_score_Request - _scoring_score_batch_Request: - properties: - dataset_id: - type: string - title: Dataset Id - scoring_functions: - additionalProperties: - anyOf: - - oneOf: - - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - title: LLMAsJudgeScoringFnParams - - $ref: '#/components/schemas/RegexParserScoringFnParams' - title: RegexParserScoringFnParams - - $ref: '#/components/schemas/BasicScoringFnParams' - title: BasicScoringFnParams - discriminator: - propertyName: type - mapping: - basic: '#/components/schemas/BasicScoringFnParams' - llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' - regex_parser: '#/components/schemas/RegexParserScoringFnParams' - title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - - type: 'null' - title: AdditionalpropertiesUnion - type: object - title: Scoring Functions - save_results_dataset: - type: boolean - title: Save Results Dataset - default: false - type: object - required: - - dataset_id - - scoring_functions - title: _scoring_score_batch_Request - _tool_runtime_invoke_Request: - properties: - tool_name: - type: string - title: Tool Name - kwargs: - additionalProperties: true - type: object - title: Kwargs - type: object - required: - - tool_name - - kwargs - title: _tool_runtime_invoke_Request - _vector_io_query_Request: - properties: - vector_store_id: - type: string - title: Vector Store Id - query: - anyOf: - - type: string - - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - - items: - oneOf: - - $ref: '#/components/schemas/ImageContentItem-Input' - title: ImageContentItem-Input - - $ref: '#/components/schemas/TextContentItem' - title: TextContentItem - discriminator: - propertyName: type - mapping: - image: '#/components/schemas/ImageContentItem-Input' - text: '#/components/schemas/TextContentItem' - title: ImageContentItem-Input | TextContentItem - type: array - title: list[ImageContentItem-Input | TextContentItem] - title: string | list[ImageContentItem-Input | TextContentItem] - params: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - required: - - vector_store_id - - query - title: _vector_io_query_Request - _vector_stores_vector_store_id_Request: - properties: - name: - anyOf: - - type: string - - type: 'null' - expires_after: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - metadata: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - type: object - title: _vector_stores_vector_store_id_Request - _vector_stores_vector_store_id_files_Request: - properties: - file_id: - type: string - title: File Id - attributes: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - chunking_strategy: - anyOf: - - oneOf: - - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - title: VectorStoreChunkingStrategyAuto - - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyStatic - discriminator: - propertyName: type - mapping: - auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' - static: '#/components/schemas/VectorStoreChunkingStrategyStatic' - title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - - type: 'null' - title: Chunking Strategy - type: object - required: - - file_id - title: _vector_stores_vector_store_id_files_Request - _vector_stores_vector_store_id_files_file_id_Request: - properties: - attributes: - additionalProperties: true - type: object - title: Attributes - type: object - required: - - attributes - title: _vector_stores_vector_store_id_files_file_id_Request - _vector_stores_vector_store_id_search_Request: - properties: - query: - anyOf: - - type: string - - items: - type: string - type: array - title: list[string] - title: string | list[string] - filters: - anyOf: - - additionalProperties: true - type: object - - type: 'null' - max_num_results: - anyOf: - - type: integer - - type: 'null' - default: 10 - ranking_options: - anyOf: - - $ref: '#/components/schemas/SearchRankingOptions' - title: SearchRankingOptions - - type: 'null' - title: SearchRankingOptions - rewrite_query: - anyOf: - - type: boolean - - type: 'null' - default: false - search_mode: - anyOf: - - type: string - - type: 'null' - default: vector - type: object - required: - - query - title: _vector_stores_vector_store_id_search_Request - Error: - description: Error response from the API. Roughly follows RFC 7807. - properties: - status: - title: Status - type: integer - title: - title: Title - type: string - detail: - title: Detail - type: string - instance: - anyOf: - - type: string - - type: 'null' - nullable: true - required: - - status - - title - - detail - title: Error - type: object ImageContentItem: description: A image content item properties: @@ -11037,6 +2653,49 @@ components: - image title: ImageContentItem type: object + TextContentItem: + description: A text content item + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextContentItem + type: object + URL: + description: A URL reference to external content. + properties: + uri: + title: Uri + type: string + required: + - uri + title: URL + type: object + _URLOrData: + description: A URL or a base64 encoded string + properties: + url: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + data: + anyOf: + - type: string + - type: 'null' + contentEncoding: base64 + nullable: true + title: _URLOrData + type: object InterleavedContentItem: discriminator: mapping: @@ -11078,110 +2737,54 @@ components: type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] - BuiltinTool: - enum: - - brave_search - - wolfram_alpha - - photogen - - code_interpreter - title: BuiltinTool - type: string - ImageDelta: - description: An image content delta for streaming responses. + GreedySamplingStrategy: + description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: - const: image - default: image + const: greedy + default: greedy title: Type type: string - image: - format: binary - title: Image - type: string - required: - - image - title: ImageDelta + title: GreedySamplingStrategy type: object - TextDelta: - description: A text content delta for streaming responses. + TopKSamplingStrategy: + description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: - const: text - default: text + const: top_k + default: top_k title: Type type: string - text: - title: Text - type: string + top_k: + minimum: 1 + title: Top K + type: integer required: - - text - title: TextDelta + - top_k + title: TopKSamplingStrategy type: object - ToolCall: + TopPSamplingStrategy: + description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: - call_id: - title: Call Id + type: + const: top_p + default: top_p + title: Type type: string - tool_name: + temperature: anyOf: - - $ref: '#/components/schemas/BuiltinTool' - title: BuiltinTool - - type: string - title: BuiltinTool | string - arguments: - title: Arguments - type: string - required: - - call_id - - tool_name - - arguments - title: ToolCall - type: object - ToolCallDelta: - description: A tool call content delta for streaming responses. - properties: - type: - const: tool_call - default: tool_call - title: Type - type: string - tool_call: + - type: number + minimum: 0.0 + - type: 'null' + top_p: anyOf: - - type: string - - $ref: '#/components/schemas/ToolCall' - title: ToolCall - title: string | ToolCall - parse_status: - $ref: '#/components/schemas/ToolCallParseStatus' + - type: number + - type: 'null' + default: 0.95 required: - - tool_call - - parse_status - title: ToolCallDelta + - temperature + title: TopPSamplingStrategy type: object - ToolCallParseStatus: - description: Status of tool call parsing during streaming. - enum: - - started - - in_progress - - failed - - succeeded - title: ToolCallParseStatus - type: string - ContentDelta: - discriminator: - mapping: - image: '#/components/schemas/ImageDelta' - text: '#/components/schemas/TextDelta' - tool_call: '#/components/schemas/ToolCallDelta' - propertyName: type - oneOf: - - $ref: '#/components/schemas/TextDelta' - title: TextDelta - - $ref: '#/components/schemas/ImageDelta' - title: ImageDelta - - $ref: '#/components/schemas/ToolCallDelta' - title: ToolCallDelta - title: TextDelta | ImageDelta | ToolCallDelta SamplingStrategy: discriminator: mapping: @@ -11241,6 +2844,82 @@ components: - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat + OpenAIChatCompletionContentPartImageParam: + description: Image content part for OpenAI-compatible chat completion messages. + properties: + type: + const: image_url + default: image_url + title: Type + type: string + image_url: + $ref: '#/components/schemas/OpenAIImageURL' + required: + - image_url + title: OpenAIChatCompletionContentPartImageParam + type: object + OpenAIChatCompletionContentPartTextParam: + description: Text content part for OpenAI-compatible chat completion messages. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: OpenAIChatCompletionContentPartTextParam + type: object + OpenAIFile: + properties: + type: + const: file + default: file + title: Type + type: string + file: + $ref: '#/components/schemas/OpenAIFileFile' + required: + - file + title: OpenAIFile + type: object + OpenAIFileFile: + properties: + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIFileFile + type: object + OpenAIImageURL: + description: Image URL specification for OpenAI-compatible chat completion messages. + properties: + url: + title: Url + type: string + detail: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - url + title: OpenAIImageURL + type: object OpenAIChatCompletionContentPartParam: discriminator: mapping: @@ -11288,6 +2967,122 @@ components: nullable: true title: OpenAIAssistantMessageParam type: object + OpenAIChatCompletionToolCall: + description: Tool call specification for OpenAI-compatible chat completion responses. + properties: + index: + anyOf: + - type: integer + - type: 'null' + nullable: true + id: + anyOf: + - type: string + - type: 'null' + nullable: true + type: + const: function + default: function + title: Type + type: string + function: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' + title: OpenAIChatCompletionToolCallFunction + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + title: OpenAIChatCompletionToolCall + type: object + OpenAIChatCompletionToolCallFunction: + description: Function call details for OpenAI-compatible tool calls. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + arguments: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIChatCompletionToolCallFunction + type: object + OpenAIDeveloperMessageParam: + description: A message from the developer in an OpenAI-compatible chat completion request. + properties: + role: + const: developer + default: developer + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAIDeveloperMessageParam + type: object + OpenAISystemMessageParam: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + name: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - content + title: OpenAISystemMessageParam + type: object + OpenAIToolMessageParam: + description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. + properties: + role: + const: tool + default: tool + title: Role + type: string + tool_call_id: + title: Tool Call Id + type: string + content: + anyOf: + - type: string + - items: + $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' + type: array + title: list[OpenAIChatCompletionContentPartTextParam] + title: string | list[OpenAIChatCompletionContentPartTextParam] + required: + - tool_call_id + - content + title: OpenAIToolMessageParam + type: object OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: @@ -11347,6 +3142,61 @@ components: - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) + OpenAIJSONSchema: + description: JSON schema specification for OpenAI-compatible structured response format. + properties: + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + title: OpenAIJSONSchema + type: object + OpenAIResponseFormatJSONObject: + description: JSON object response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_object + default: json_object + title: Type + type: string + title: OpenAIResponseFormatJSONObject + type: object + OpenAIResponseFormatJSONSchema: + description: JSON schema response format for OpenAI-compatible chat completion requests. + properties: + type: + const: json_schema + default: json_schema + title: Type + type: string + json_schema: + $ref: '#/components/schemas/OpenAIJSONSchema' + required: + - json_schema + title: OpenAIResponseFormatJSONSchema + type: object + OpenAIResponseFormatText: + description: Text response format for OpenAI-compatible chat completion requests. + properties: + type: + const: text + default: text + title: Type + type: string + title: OpenAIResponseFormatText + type: object OpenAIResponseFormatParam: discriminator: mapping: @@ -11362,6 +3212,45 @@ components: - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + VectorStoreChunkingStrategyAuto: + description: Automatic chunking strategy for vector store files. + properties: + type: + const: auto + default: auto + title: Type + type: string + title: VectorStoreChunkingStrategyAuto + type: object + VectorStoreChunkingStrategyStatic: + description: Static chunking strategy with configurable parameters. + properties: + type: + const: static + default: static + title: Type + type: string + static: + $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' + required: + - static + title: VectorStoreChunkingStrategyStatic + type: object + VectorStoreChunkingStrategyStaticConfig: + description: Configuration for static chunking strategy. + properties: + chunk_overlap_tokens: + default: 400 + title: Chunk Overlap Tokens + type: integer + max_chunk_size_tokens: + default: 800 + maximum: 4096 + minimum: 100 + title: Max Chunk Size Tokens + type: integer + title: VectorStoreChunkingStrategyStaticConfig + type: object VectorStoreChunkingStrategy: discriminator: mapping: @@ -11382,6 +3271,79 @@ components: - cancelled - failed default: completed + OpenAIResponseInputMessageContentFile: + description: File content for input messages in OpenAI response format. + properties: + type: + const: input_file + default: input_file + title: Type + type: string + file_data: + anyOf: + - type: string + - type: 'null' + nullable: true + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + file_url: + anyOf: + - type: string + - type: 'null' + nullable: true + filename: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentFile + type: object + OpenAIResponseInputMessageContentImage: + description: Image content for input messages in OpenAI response format. + properties: + detail: + default: auto + title: Detail + type: string + enum: + - low + - high + - auto + type: + const: input_image + default: input_image + title: Type + type: string + file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + image_url: + anyOf: + - type: string + - type: 'null' + nullable: true + title: OpenAIResponseInputMessageContentImage + type: object + OpenAIResponseInputMessageContentText: + description: Text content for input messages in OpenAI response format. + properties: + text: + title: Text + type: string + type: + const: input_text + default: input_text + title: Type + type: string + required: + - text + title: OpenAIResponseInputMessageContentText + type: object OpenAIResponseInputMessageContent: discriminator: mapping: @@ -11397,6 +3359,104 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + OpenAIResponseAnnotationCitation: + description: URL citation annotation for referencing external web resources. + properties: + type: + const: url_citation + default: url_citation + title: Type + type: string + end_index: + title: End Index + type: integer + start_index: + title: Start Index + type: integer + title: + title: Title + type: string + url: + title: Url + type: string + required: + - end_index + - start_index + - title + - url + title: OpenAIResponseAnnotationCitation + type: object + OpenAIResponseAnnotationContainerFileCitation: + properties: + type: + const: container_file_citation + default: container_file_citation + title: Type + type: string + container_id: + title: Container Id + type: string + end_index: + title: End Index + type: integer + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + start_index: + title: Start Index + type: integer + required: + - container_id + - end_index + - file_id + - filename + - start_index + title: OpenAIResponseAnnotationContainerFileCitation + type: object + OpenAIResponseAnnotationFileCitation: + description: File citation annotation for referencing specific files in response content. + properties: + type: + const: file_citation + default: file_citation + title: Type + type: string + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + index: + title: Index + type: integer + required: + - file_id + - filename + - index + title: OpenAIResponseAnnotationFileCitation + type: object + OpenAIResponseAnnotationFilePath: + properties: + type: + const: file_path + default: file_path + title: Type + type: string + file_id: + title: File Id + type: string + index: + title: Index + type: integer + required: + - file_id + - index + title: OpenAIResponseAnnotationFilePath + type: object OpenAIResponseAnnotations: discriminator: mapping: @@ -11415,6 +3475,56 @@ components: - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + OpenAIResponseContentPartRefusal: + description: Refusal content within a streamed response part. + properties: + type: + const: refusal + default: refusal + title: Type + type: string + refusal: + title: Refusal + type: string + required: + - refusal + title: OpenAIResponseContentPartRefusal + type: object + OpenAIResponseOutputMessageContentOutputText: + properties: + text: + title: Text + type: string + type: + const: output_text + default: output_text + title: Type + type: string + annotations: + items: + discriminator: + mapping: + container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' + url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' + title: OpenAIResponseAnnotationFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' + title: OpenAIResponseAnnotationCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' + title: OpenAIResponseAnnotationContainerFileCitation + - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' + title: OpenAIResponseAnnotationFilePath + title: OpenAIResponseAnnotationFileCitation | ... (4 variants) + title: Annotations + type: array + required: + - text + title: OpenAIResponseOutputMessageContentOutputText + type: object OpenAIResponseOutputMessageContent: discriminator: mapping: @@ -11427,6 +3537,53 @@ components: - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal + MCPListToolsTool: + description: Tool definition returned by MCP list tools operation. + properties: + input_schema: + additionalProperties: true + title: Input Schema + type: object + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - input_schema + - name + title: MCPListToolsTool + type: object + OpenAIResponseMCPApprovalRequest: + description: A request for human approval of a tool invocation. + properties: + arguments: + title: Arguments + type: string + id: + title: Id + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + type: + const: mcp_approval_request + default: mcp_approval_request + title: Type + type: string + required: + - arguments + - id + - name + - server_label + title: OpenAIResponseMCPApprovalRequest + type: object OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. @@ -11498,6 +3655,179 @@ components: - role title: OpenAIResponseMessage type: object + OpenAIResponseOutputMessageFileSearchToolCall: + description: File search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + queries: + items: + type: string + title: Queries + type: array + status: + title: Status + type: string + type: + const: file_search_call + default: file_search_call + title: Type + type: string + results: + anyOf: + - items: + $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' + type: array + - type: 'null' + nullable: true + required: + - id + - queries + - status + title: OpenAIResponseOutputMessageFileSearchToolCall + type: object + OpenAIResponseOutputMessageFileSearchToolCallResults: + description: Search results returned by the file search operation. + properties: + attributes: + additionalProperties: true + title: Attributes + type: object + file_id: + title: File Id + type: string + filename: + title: Filename + type: string + score: + title: Score + type: number + text: + title: Text + type: string + required: + - attributes + - file_id + - filename + - score + - text + title: OpenAIResponseOutputMessageFileSearchToolCallResults + type: object + OpenAIResponseOutputMessageFunctionToolCall: + description: Function tool call output message for OpenAI responses. + properties: + call_id: + title: Call Id + type: string + name: + title: Name + type: string + arguments: + title: Arguments + type: string + type: + const: function_call + default: function_call + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - name + - arguments + title: OpenAIResponseOutputMessageFunctionToolCall + type: object + OpenAIResponseOutputMessageMCPCall: + description: Model Context Protocol (MCP) call output message for OpenAI responses. + properties: + id: + title: Id + type: string + type: + const: mcp_call + default: mcp_call + title: Type + type: string + arguments: + title: Arguments + type: string + name: + title: Name + type: string + server_label: + title: Server Label + type: string + error: + anyOf: + - type: string + - type: 'null' + nullable: true + output: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + - arguments + - name + - server_label + title: OpenAIResponseOutputMessageMCPCall + type: object + OpenAIResponseOutputMessageMCPListTools: + description: MCP list tools output message containing available tools from an MCP server. + properties: + id: + title: Id + type: string + type: + const: mcp_list_tools + default: mcp_list_tools + title: Type + type: string + server_label: + title: Server Label + type: string + tools: + items: + $ref: '#/components/schemas/MCPListToolsTool' + title: Tools + type: array + required: + - id + - server_label + - tools + title: OpenAIResponseOutputMessageMCPListTools + type: object + OpenAIResponseOutputMessageWebSearchToolCall: + description: Web search tool call output message for OpenAI responses. + properties: + id: + title: Id + type: string + status: + title: Status + type: string + type: + const: web_search_call + default: web_search_call + title: Type + type: string + required: + - id + - status + title: OpenAIResponseOutputMessageWebSearchToolCall + type: object OpenAIResponseOutput: discriminator: mapping: @@ -11525,6 +3855,186 @@ components: - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) + AllowedToolsFilter: + description: Filter configuration for restricting which MCP tools can be used. + properties: + tool_names: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: AllowedToolsFilter + type: object + ApprovalFilter: + description: Filter configuration for MCP tool approval requirements. + properties: + always: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + never: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: ApprovalFilter + type: object + OpenAIResponseInputToolFileSearch: + description: File search tool configuration for OpenAI response inputs. + properties: + type: + const: file_search + default: file_search + title: Type + type: string + vector_store_ids: + items: + type: string + title: Vector Store Ids + type: array + filters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + max_num_results: + anyOf: + - maximum: 50 + minimum: 1 + type: integer + - type: 'null' + default: 10 + ranking_options: + anyOf: + - $ref: '#/components/schemas/SearchRankingOptions' + title: SearchRankingOptions + - type: 'null' + nullable: true + title: SearchRankingOptions + required: + - vector_store_ids + title: OpenAIResponseInputToolFileSearch + type: object + OpenAIResponseInputToolFunction: + description: Function tool configuration for OpenAI response inputs. + properties: + type: + const: function + default: function + title: Type + type: string + name: + title: Name + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + parameters: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + nullable: true + required: + - name + - parameters + title: OpenAIResponseInputToolFunction + type: object + OpenAIResponseInputToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + server_url: + title: Server Url + type: string + headers: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + require_approval: + anyOf: + - const: always + type: string + - const: never + type: string + - $ref: '#/components/schemas/ApprovalFilter' + title: ApprovalFilter + default: never + title: string | ApprovalFilter + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + - server_url + title: OpenAIResponseInputToolMCP + type: object + OpenAIResponseInputToolWebSearch: + description: Web search tool configuration for OpenAI response inputs. + properties: + type: + default: web_search + title: Type + type: string + enum: + - web_search + - web_search_preview + - web_search_preview_2025_03_11 + - web_search_2025_08_26 + search_context_size: + anyOf: + - pattern: ^low|medium|high$ + type: string + - type: 'null' + default: medium + title: OpenAIResponseInputToolWebSearch + type: object + SearchRankingOptions: + description: Options for ranking and filtering search results. + properties: + ranker: + anyOf: + - type: string + - type: 'null' + nullable: true + score_threshold: + anyOf: + - type: number + - type: 'null' + default: 0.0 + title: SearchRankingOptions + type: object OpenAIResponseInputTool: discriminator: mapping: @@ -11546,6 +4056,32 @@ components: - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) + OpenAIResponseToolMCP: + description: Model Context Protocol (MCP) tool configuration for OpenAI response object. + properties: + type: + const: mcp + default: mcp + title: Type + type: string + server_label: + title: Server Label + type: string + allowed_tools: + anyOf: + - items: + type: string + type: array + title: list[string] + - $ref: '#/components/schemas/AllowedToolsFilter' + title: AllowedToolsFilter + - type: 'null' + title: list[string] | AllowedToolsFilter + nullable: true + required: + - server_label + title: OpenAIResponseToolMCP + type: object OpenAIResponseTool: discriminator: mapping: @@ -11656,6 +4192,164 @@ components: - text title: OpenAIResponseContentPartReasoningSummary type: object + OpenAIResponseError: + description: Error details for failed OpenAI response requests. + properties: + code: + title: Code + type: string + message: + title: Message + type: string + required: + - code + - message + title: OpenAIResponseError + type: object + OpenAIResponseObject: + description: Complete OpenAI response object containing generation results and metadata. + properties: + created_at: + title: Created At + type: integer + error: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseError' + title: OpenAIResponseError + - type: 'null' + nullable: true + title: OpenAIResponseError + id: + title: Id + type: string + model: + title: Model + type: string + object: + const: response + default: response + title: Object + type: string + output: + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + title: Output + type: array + parallel_tool_calls: + default: false + title: Parallel Tool Calls + type: boolean + previous_response_id: + anyOf: + - type: string + - type: 'null' + nullable: true + prompt: + anyOf: + - $ref: '#/components/schemas/OpenAIResponsePrompt' + title: OpenAIResponsePrompt + - type: 'null' + nullable: true + title: OpenAIResponsePrompt + status: + title: Status + type: string + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + text: + $ref: '#/components/schemas/OpenAIResponseText' + default: + format: + type: text + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + tools: + anyOf: + - items: + discriminator: + mapping: + file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' + function: '#/components/schemas/OpenAIResponseInputToolFunction' + mcp: '#/components/schemas/OpenAIResponseToolMCP' + web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' + web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' + title: OpenAIResponseInputToolWebSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' + title: OpenAIResponseInputToolFileSearch + - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' + title: OpenAIResponseInputToolFunction + - $ref: '#/components/schemas/OpenAIResponseToolMCP' + title: OpenAIResponseToolMCP + title: OpenAIResponseInputToolWebSearch | ... (4 variants) + type: array + - type: 'null' + nullable: true + truncation: + anyOf: + - type: string + - type: 'null' + nullable: true + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsage' + title: OpenAIResponseUsage + - type: 'null' + nullable: true + title: OpenAIResponseUsage + instructions: + anyOf: + - type: string + - type: 'null' + nullable: true + max_tool_calls: + anyOf: + - type: integer + - type: 'null' + nullable: true + required: + - created_at + - id + - model + - output + - status + title: OpenAIResponseObject + type: object OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: @@ -12630,6 +5324,135 @@ components: - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object + OpenAIResponsePrompt: + description: OpenAI compatible Prompt object that is used in OpenAI responses. + properties: + id: + title: Id + type: string + variables: + anyOf: + - additionalProperties: + discriminator: + mapping: + input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' + input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' + input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' + title: OpenAIResponseInputMessageContentText + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' + title: OpenAIResponseInputMessageContentImage + - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' + title: OpenAIResponseInputMessageContentFile + title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile + type: object + - type: 'null' + nullable: true + version: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - id + title: OpenAIResponsePrompt + type: object + OpenAIResponseText: + description: Text response configuration for OpenAI responses. + properties: + format: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseTextFormat' + title: OpenAIResponseTextFormat + - type: 'null' + nullable: true + title: OpenAIResponseTextFormat + title: OpenAIResponseText + type: object + OpenAIResponseTextFormat: + description: Configuration for Responses API text format. + properties: + type: + title: Type + type: string + enum: + - text + - json_schema + - json_object + default: text + name: + anyOf: + - type: string + - type: 'null' + schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + description: + anyOf: + - type: string + - type: 'null' + strict: + anyOf: + - type: boolean + - type: 'null' + title: OpenAIResponseTextFormat + type: object + OpenAIResponseUsage: + description: Usage information for OpenAI response. + properties: + input_tokens: + title: Input Tokens + type: integer + output_tokens: + title: Output Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + input_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' + title: OpenAIResponseUsageInputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + output_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' + title: OpenAIResponseUsageOutputTokensDetails + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + required: + - input_tokens + - output_tokens + - total_tokens + title: OpenAIResponseUsage + type: object + OpenAIResponseUsageInputTokensDetails: + description: Token details for input tokens in OpenAI response usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageInputTokensDetails + type: object + OpenAIResponseUsageOutputTokensDetails: + description: Token details for output tokens in OpenAI response usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIResponseUsageOutputTokensDetails + type: object OpenAIResponseObjectStream: discriminator: mapping: @@ -12744,6 +5567,64 @@ components: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) + OpenAIResponseInputFunctionToolCallOutput: + description: This represents the output of a function call that gets passed back to the model. + properties: + call_id: + title: Call Id + type: string + output: + title: Output + type: string + type: + const: function_call_output + default: function_call_output + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + status: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - call_id + - output + title: OpenAIResponseInputFunctionToolCallOutput + type: object + OpenAIResponseMCPApprovalResponse: + description: A response to an MCP approval request. + properties: + approval_request_id: + title: Approval Request Id + type: string + approve: + title: Approve + type: boolean + type: + const: mcp_approval_response + default: mcp_approval_response + title: Type + type: string + id: + anyOf: + - type: string + - type: 'null' + nullable: true + reason: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - approval_request_id + - approve + title: OpenAIResponseMCPApprovalResponse + type: object OpenAIResponseInput: anyOf: - discriminator: @@ -12779,51 +5660,96 @@ components: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage - ConversationItem: - discriminator: - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - propertyName: type - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage' - title: OpenAIResponseMessage - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - title: OpenAIResponseMessage | ... (9 variants) - DataSource: - discriminator: - mapping: - rows: '#/components/schemas/RowsDataSource' - uri: '#/components/schemas/URIDataSource' - propertyName: type - oneOf: - - $ref: '#/components/schemas/URIDataSource' - title: URIDataSource - - $ref: '#/components/schemas/RowsDataSource' - title: RowsDataSource - title: URIDataSource | RowsDataSource + ArrayType: + description: Parameter type for array values. + properties: + type: + const: array + default: array + title: Type + type: string + title: ArrayType + type: object + BooleanType: + description: Parameter type for boolean values. + properties: + type: + const: boolean + default: boolean + title: Type + type: string + title: BooleanType + type: object + ChatCompletionInputType: + description: Parameter type for chat completion input. + properties: + type: + const: chat_completion_input + default: chat_completion_input + title: Type + type: string + title: ChatCompletionInputType + type: object + CompletionInputType: + description: Parameter type for completion input. + properties: + type: + const: completion_input + default: completion_input + title: Type + type: string + title: CompletionInputType + type: object + JsonType: + description: Parameter type for JSON values. + properties: + type: + const: json + default: json + title: Type + type: string + title: JsonType + type: object + NumberType: + description: Parameter type for numeric values. + properties: + type: + const: number + default: number + title: Type + type: string + title: NumberType + type: object + ObjectType: + description: Parameter type for object values. + properties: + type: + const: object + default: object + title: Type + type: string + title: ObjectType + type: object + StringType: + description: Parameter type for string values. + properties: + type: + const: string + default: string + title: Type + type: string + title: StringType + type: object + UnionType: + description: Parameter type for union values. + properties: + type: + const: union + default: union + title: Type + type: string + title: UnionType + type: object ParamType: discriminator: mapping: @@ -12857,6 +5783,164 @@ components: - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) + ConversationItem: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + RowsDataSource: + description: A dataset stored in rows. + properties: + type: + const: rows + default: rows + title: Type + type: string + rows: + items: + additionalProperties: true + type: object + title: Rows + type: array + required: + - rows + title: RowsDataSource + type: object + URIDataSource: + description: A dataset that can be obtained from a URI. + properties: + type: + const: uri + default: uri + title: Type + type: string + uri: + title: Uri + type: string + required: + - uri + title: URIDataSource + type: object + DataSource: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + AggregationFunctionType: + description: Types of aggregation functions for scoring results. + enum: + - average + - weighted_average + - median + - categorical_count + - accuracy + title: AggregationFunctionType + type: string + BasicScoringFnParams: + description: Parameters for basic scoring function configuration. + properties: + type: + const: basic + default: basic + title: Type + type: string + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: BasicScoringFnParams + type: object + LLMAsJudgeScoringFnParams: + description: Parameters for LLM-as-judge scoring function configuration. + properties: + type: + const: llm_as_judge + default: llm_as_judge + title: Type + type: string + judge_model: + title: Judge Model + type: string + prompt_template: + anyOf: + - type: string + - type: 'null' + nullable: true + judge_score_regexes: + description: Regexes to extract the answer from generated response + items: + type: string + title: Judge Score Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + required: + - judge_model + title: LLMAsJudgeScoringFnParams + type: object + RegexParserScoringFnParams: + description: Parameters for regex parser scoring function configuration. + properties: + type: + const: regex_parser + default: regex_parser + title: Type + type: string + parsing_regexes: + description: Regex to extract the answer from generated response + items: + type: string + title: Parsing Regexes + type: array + aggregation_functions: + description: Aggregation functions to apply to the scores of each row + items: + $ref: '#/components/schemas/AggregationFunctionType' + title: Aggregation Functions + type: array + title: RegexParserScoringFnParams + type: object ScoringFnParams: discriminator: mapping: @@ -12872,6 +5956,68 @@ components: - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + LoraFinetuningConfig: + description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. + properties: + type: + const: LoRA + default: LoRA + title: Type + type: string + lora_attn_modules: + items: + type: string + title: Lora Attn Modules + type: array + apply_lora_to_mlp: + title: Apply Lora To Mlp + type: boolean + apply_lora_to_output: + title: Apply Lora To Output + type: boolean + rank: + title: Rank + type: integer + alpha: + title: Alpha + type: integer + use_dora: + anyOf: + - type: boolean + - type: 'null' + default: false + quantize_base: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - lora_attn_modules + - apply_lora_to_mlp + - apply_lora_to_output + - rank + - alpha + title: LoraFinetuningConfig + type: object + QATFinetuningConfig: + description: Configuration for Quantization-Aware Training (QAT) fine-tuning. + properties: + type: + const: QAT + default: QAT + title: Type + type: string + quantizer_name: + title: Quantizer Name + type: string + group_size: + title: Group Size + type: integer + required: + - quantizer_name + - group_size + title: QATFinetuningConfig + type: object AlgorithmConfig: discriminator: mapping: @@ -13105,15 +6251,55 @@ components: - $ref: '#/components/schemas/StructuredLogEvent' title: StructuredLogEvent title: UnstructuredLogEvent | MetricEvent | StructuredLogEvent - ResponseGuardrailSpec: - description: Specification for a guardrail to apply during response generation. + ListOpenAIResponseInputItem: + description: List container for OpenAI response input items. properties: - type: - title: Type + data: + items: + anyOf: + - discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + title: OpenAIResponseMessage | ... (7 variants) + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage + title: Data + type: array + object: + const: list + default: list + title: Object type: string required: - - type - title: ResponseGuardrailSpec + - data + title: ListOpenAIResponseInputItem type: object OpenAIResponseObjectWithInput: description: OpenAI response object extended with input context information. @@ -13298,6 +6484,426 @@ components: - input title: OpenAIResponseObjectWithInput type: object + ListOpenAIResponseObject: + description: Paginated list of OpenAI response objects with navigation metadata. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIResponseObjectWithInput' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIResponseObject + type: object + OpenAIDeleteResponseObject: + description: Response object confirming deletion of an OpenAI response. + properties: + id: + title: Id + type: string + object: + const: response + default: response + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: OpenAIDeleteResponseObject + type: object + ResponseGuardrailSpec: + description: Specification for a guardrail to apply during response generation. + properties: + type: + title: Type + type: string + required: + - type + title: ResponseGuardrailSpec + type: object + Batch: + additionalProperties: true + properties: + id: + title: Id + type: string + completion_window: + title: Completion Window + type: string + created_at: + title: Created At + type: integer + endpoint: + title: Endpoint + type: string + input_file_id: + title: Input File Id + type: string + object: + const: batch + title: Object + type: string + status: + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + title: Status + type: string + cancelled_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + cancelling_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + completed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + error_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + errors: + anyOf: + - $ref: '#/components/schemas/Errors' + title: Errors + - type: 'null' + nullable: true + title: Errors + expired_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + failed_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + finalizing_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + in_progress_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + nullable: true + model: + anyOf: + - type: string + - type: 'null' + nullable: true + output_file_id: + anyOf: + - type: string + - type: 'null' + nullable: true + request_counts: + anyOf: + - $ref: '#/components/schemas/BatchRequestCounts' + title: BatchRequestCounts + - type: 'null' + nullable: true + title: BatchRequestCounts + usage: + anyOf: + - $ref: '#/components/schemas/BatchUsage' + title: BatchUsage + - type: 'null' + nullable: true + title: BatchUsage + required: + - id + - completion_window + - created_at + - endpoint + - input_file_id + - object + - status + title: Batch + type: object + BatchError: + additionalProperties: true + properties: + code: + anyOf: + - type: string + - type: 'null' + nullable: true + line: + anyOf: + - type: integer + - type: 'null' + nullable: true + message: + anyOf: + - type: string + - type: 'null' + nullable: true + param: + anyOf: + - type: string + - type: 'null' + nullable: true + title: BatchError + type: object + BatchRequestCounts: + additionalProperties: true + properties: + completed: + title: Completed + type: integer + failed: + title: Failed + type: integer + total: + title: Total + type: integer + required: + - completed + - failed + - total + title: BatchRequestCounts + type: object + BatchUsage: + additionalProperties: true + properties: + input_tokens: + title: Input Tokens + type: integer + input_tokens_details: + $ref: '#/components/schemas/InputTokensDetails' + output_tokens: + title: Output Tokens + type: integer + output_tokens_details: + $ref: '#/components/schemas/OutputTokensDetails' + total_tokens: + title: Total Tokens + type: integer + required: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + title: BatchUsage + type: object + Errors: + additionalProperties: true + properties: + data: + anyOf: + - items: + $ref: '#/components/schemas/BatchError' + type: array + - type: 'null' + nullable: true + object: + anyOf: + - type: string + - type: 'null' + nullable: true + title: Errors + type: object + InputTokensDetails: + additionalProperties: true + properties: + cached_tokens: + title: Cached Tokens + type: integer + required: + - cached_tokens + title: InputTokensDetails + type: object + OutputTokensDetails: + additionalProperties: true + properties: + reasoning_tokens: + title: Reasoning Tokens + type: integer + required: + - reasoning_tokens + title: OutputTokensDetails + type: object + ListBatchesResponse: + description: Response containing a list of batch objects. + properties: + object: + const: list + default: list + title: Object + type: string + data: + description: List of batch objects + items: + $ref: '#/components/schemas/Batch' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: ID of the first batch in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: ID of the last batch in the list + nullable: true + has_more: + default: false + description: Whether there are more batches available + title: Has More + type: boolean + required: + - data + title: ListBatchesResponse + type: object + Benchmark: + description: A benchmark resource for evaluating model performance. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: benchmark + default: benchmark + title: Type + type: string + dataset_id: + title: Dataset Id + type: string + scoring_functions: + items: + type: string + title: Scoring Functions + type: array + metadata: + additionalProperties: true + description: Metadata for this evaluation task + title: Metadata + type: object + required: + - identifier + - provider_id + - dataset_id + - scoring_functions + title: Benchmark + type: object + ImageDelta: + description: An image content delta for streaming responses. + properties: + type: + const: image + default: image + title: Type + type: string + image: + format: binary + title: Image + type: string + required: + - image + title: ImageDelta + type: object + TextDelta: + description: A text content delta for streaming responses. + properties: + type: + const: text + default: text + title: Type + type: string + text: + title: Text + type: string + required: + - text + title: TextDelta + type: object + JobStatus: + description: Status of a job execution. + enum: + - completed + - in_progress + - failed + - scheduled + - cancelled + title: JobStatus + type: string + Job: + description: A job execution instance with status tracking. + properties: + job_id: + title: Job Id + type: string + status: + $ref: '#/components/schemas/JobStatus' + required: + - job_id + - status + title: Job + type: object MetricInResponse: description: A metric value included in API responses. properties: @@ -13319,6 +6925,84 @@ components: - value title: MetricInResponse type: object + PaginatedResponse: + description: A generic paginated response that follows a simple format. + properties: + data: + items: + additionalProperties: true + type: object + title: Data + type: array + has_more: + title: Has More + type: boolean + url: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + - has_more + title: PaginatedResponse + type: object + PostTrainingMetric: + description: Training metrics captured during post-training jobs. + properties: + epoch: + title: Epoch + type: integer + train_loss: + title: Train Loss + type: number + validation_loss: + title: Validation Loss + type: number + perplexity: + title: Perplexity + type: number + required: + - epoch + - train_loss + - validation_loss + - perplexity + title: PostTrainingMetric + type: object + Checkpoint: + description: Checkpoint created during training runs. + properties: + identifier: + title: Identifier + type: string + created_at: + format: date-time + title: Created At + type: string + epoch: + title: Epoch + type: integer + post_training_job_id: + title: Post Training Job Id + type: string + path: + title: Path + type: string + training_metrics: + anyOf: + - $ref: '#/components/schemas/PostTrainingMetric' + title: PostTrainingMetric + - type: 'null' + nullable: true + title: PostTrainingMetric + required: + - identifier + - created_at + - epoch + - post_training_job_id + - path + title: Checkpoint + type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: @@ -13329,6 +7013,66 @@ components: type: string title: DialogType type: object + Conversation: + description: OpenAI-compatible conversation object. + properties: + id: + description: The unique ID of the conversation. + title: Id + type: string + object: + const: conversation + default: conversation + description: The object type, which is always conversation. + title: Object + type: string + created_at: + description: The time at which the conversation was created, measured in seconds since the Unix epoch. + title: Created At + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. + nullable: true + items: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + description: Initial items to include in the conversation context. You may add up to 20 items at a time. + nullable: true + required: + - id + - created_at + title: Conversation + type: object + ConversationDeletedResource: + description: Response for deleted conversation. + properties: + id: + description: The deleted conversation identifier + title: Id + type: string + object: + default: conversation.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationDeletedResource + type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: @@ -13374,6 +7118,93 @@ components: - items title: ConversationItemCreateRequest type: object + ConversationItemDeletedResource: + description: Response for deleted conversation item. + properties: + id: + description: The deleted item identifier + title: Id + type: string + object: + default: conversation.item.deleted + description: Object type + title: Object + type: string + deleted: + default: true + description: Whether the object was deleted + title: Deleted + type: boolean + required: + - id + title: ConversationItemDeletedResource + type: object + ConversationItemList: + description: List of conversation items with pagination. + properties: + object: + default: list + description: Object type + title: Object + type: string + data: + description: List of conversation items + items: + discriminator: + mapping: + file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + message: '#/components/schemas/OpenAIResponseMessage' + web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseMessage' + title: OpenAIResponseMessage + - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' + title: OpenAIResponseOutputMessageWebSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' + title: OpenAIResponseOutputMessageFileSearchToolCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' + title: OpenAIResponseOutputMessageFunctionToolCall + - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' + title: OpenAIResponseInputFunctionToolCallOutput + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' + title: OpenAIResponseMCPApprovalRequest + - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' + title: OpenAIResponseMCPApprovalResponse + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' + title: OpenAIResponseOutputMessageMCPCall + - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' + title: OpenAIResponseOutputMessageMCPListTools + title: OpenAIResponseMessage | ... (9 variants) + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the first item in the list + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + description: The ID of the last item in the list + nullable: true + has_more: + default: false + description: Whether there are more items available + title: Has More + type: boolean + required: + - data + title: ConversationItemList + type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: @@ -13413,6 +7244,857 @@ components: - status title: ConversationMessage type: object + DatasetPurpose: + description: Purpose of the dataset. Each purpose has a required input data schema. + enum: + - post-training/messages + - eval/question-answer + - eval/messages-answer + title: DatasetPurpose + type: string + Dataset: + description: Dataset resource for storing and accessing training or evaluation data. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: dataset + default: dataset + title: Type + type: string + purpose: + $ref: '#/components/schemas/DatasetPurpose' + source: + discriminator: + mapping: + rows: '#/components/schemas/RowsDataSource' + uri: '#/components/schemas/URIDataSource' + propertyName: type + oneOf: + - $ref: '#/components/schemas/URIDataSource' + title: URIDataSource + - $ref: '#/components/schemas/RowsDataSource' + title: RowsDataSource + title: URIDataSource | RowsDataSource + metadata: + additionalProperties: true + description: Any additional metadata for this dataset + title: Metadata + type: object + required: + - identifier + - provider_id + - purpose + - source + title: Dataset + type: object + Error: + description: Error response from the API. Roughly follows RFC 7807. + properties: + status: + title: Status + type: integer + title: + title: Title + type: string + detail: + title: Detail + type: string + instance: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - status + - title + - detail + title: Error + type: object + Api: + description: Enumeration of all available APIs in the Llama Stack system. + enum: + - providers + - inference + - safety + - agents + - batches + - vector_io + - datasetio + - scoring + - eval + - post_training + - tool_runtime + - models + - shields + - vector_stores + - datasets + - scoring_functions + - benchmarks + - tool_groups + - files + - prompts + - conversations + - inspect + title: Api + type: string + InlineProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + container_image: + anyOf: + - type: string + - type: 'null' + description: |2 + + The container image to use for this implementation. If one is provided, pip_packages will be ignored. + If a provider depends on other providers, the dependencies MUST NOT specify a container image. + nullable: true + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + title: InlineProviderSpec + type: object + ModelType: + description: Enumeration of supported model types in Llama Stack. + enum: + - llm + - embedding + - rerank + title: ModelType + type: string + Model: + description: A model resource representing an AI model registered in Llama Stack. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: model + default: model + title: Type + type: string + metadata: + additionalProperties: true + description: Any additional metadata for this model + title: Metadata + type: object + model_type: + $ref: '#/components/schemas/ModelType' + default: llm + required: + - identifier + - provider_id + title: Model + type: object + ProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + required: + - api + - provider_type + - config_class + title: ProviderSpec + type: object + RemoteProviderSpec: + properties: + api: + $ref: '#/components/schemas/Api' + provider_type: + title: Provider Type + type: string + config_class: + description: Fully-qualified classname of the config for this provider + title: Config Class + type: string + api_dependencies: + description: Higher-level API surfaces may depend on other providers to provide their functionality + items: + $ref: '#/components/schemas/Api' + title: Api Dependencies + type: array + optional_api_dependencies: + items: + $ref: '#/components/schemas/Api' + title: Optional Api Dependencies + type: array + deprecation_warning: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated, specify the warning message here + nullable: true + deprecation_error: + anyOf: + - type: string + - type: 'null' + description: If this provider is deprecated and does NOT work, specify the error message here + nullable: true + module: + anyOf: + - type: string + - type: 'null' + description: |2- + + Fully-qualified name of the module to import. The module is expected to have: + + - `get_adapter_impl(config, deps)`: returns the adapter implementation + + Example: `module: ramalama_stack` + + nullable: true + pip_packages: + description: The pip dependencies needed for this implementation + items: + type: string + title: Pip Packages + type: array + provider_data_validator: + anyOf: + - type: string + - type: 'null' + nullable: true + is_external: + default: false + description: Notes whether this provider is an external provider. + title: Is External + type: boolean + deps__: + items: + type: string + title: Deps + type: array + adapter_type: + description: Unique identifier for this adapter + title: Adapter Type + type: string + description: + anyOf: + - type: string + - type: 'null' + description: |2 + + A description of the provider. This is used to display in the documentation. + nullable: true + required: + - api + - provider_type + - config_class + - adapter_type + title: RemoteProviderSpec + type: object + ScoringFn: + description: A scoring function resource for evaluating model outputs. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: scoring_function + default: scoring_function + title: Type + type: string + description: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + description: Any additional metadata for this definition + title: Metadata + type: object + return_type: + description: The return type of the deterministic function + discriminator: + mapping: + array: '#/components/schemas/ArrayType' + boolean: '#/components/schemas/BooleanType' + chat_completion_input: '#/components/schemas/ChatCompletionInputType' + completion_input: '#/components/schemas/CompletionInputType' + json: '#/components/schemas/JsonType' + number: '#/components/schemas/NumberType' + object: '#/components/schemas/ObjectType' + string: '#/components/schemas/StringType' + union: '#/components/schemas/UnionType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/StringType' + title: StringType + - $ref: '#/components/schemas/NumberType' + title: NumberType + - $ref: '#/components/schemas/BooleanType' + title: BooleanType + - $ref: '#/components/schemas/ArrayType' + title: ArrayType + - $ref: '#/components/schemas/ObjectType' + title: ObjectType + - $ref: '#/components/schemas/JsonType' + title: JsonType + - $ref: '#/components/schemas/UnionType' + title: UnionType + - $ref: '#/components/schemas/ChatCompletionInputType' + title: ChatCompletionInputType + - $ref: '#/components/schemas/CompletionInputType' + title: CompletionInputType + title: StringType | ... (9 variants) + params: + anyOf: + - discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + - type: 'null' + description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval + title: Params + nullable: true + required: + - identifier + - provider_id + - return_type + title: ScoringFn + type: object + Shield: + description: A safety shield resource that can be used to check content. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: shield + default: shield + title: Type + type: string + params: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: Shield + type: object + ToolGroup: + description: A group of related tools managed together. + properties: + identifier: + description: Unique identifier for this resource in llama stack + title: Identifier + type: string + provider_resource_id: + anyOf: + - type: string + - type: 'null' + description: Unique identifier for this resource in the provider + nullable: true + provider_id: + description: ID of the provider that owns this resource + title: Provider Id + type: string + type: + const: tool_group + default: tool_group + title: Type + type: string + mcp_endpoint: + anyOf: + - $ref: '#/components/schemas/URL' + title: URL + - type: 'null' + nullable: true + title: URL + args: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - identifier + - provider_id + title: ToolGroup + type: object + ModelCandidate: + description: A model candidate for evaluation. + properties: + type: + const: model + default: model + title: Type + type: string + model: + title: Model + type: string + sampling_params: + $ref: '#/components/schemas/SamplingParams' + system_message: + anyOf: + - $ref: '#/components/schemas/SystemMessage' + title: SystemMessage + - type: 'null' + nullable: true + title: SystemMessage + required: + - model + - sampling_params + title: ModelCandidate + type: object + SamplingParams: + description: Sampling parameters. + properties: + strategy: + discriminator: + mapping: + greedy: '#/components/schemas/GreedySamplingStrategy' + top_k: '#/components/schemas/TopKSamplingStrategy' + top_p: '#/components/schemas/TopPSamplingStrategy' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreedySamplingStrategy' + title: GreedySamplingStrategy + - $ref: '#/components/schemas/TopPSamplingStrategy' + title: TopPSamplingStrategy + - $ref: '#/components/schemas/TopKSamplingStrategy' + title: TopKSamplingStrategy + title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + repetition_penalty: + anyOf: + - type: number + - type: 'null' + default: 1.0 + stop: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + title: SamplingParams + type: object + SystemMessage: + description: A system message providing instructions or context to the model. + properties: + role: + const: system + default: system + title: Role + type: string + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + title: string | list[ImageContentItem | TextContentItem] + required: + - content + title: SystemMessage + type: object + BenchmarkConfig: + description: A benchmark configuration for evaluation. + properties: + eval_candidate: + $ref: '#/components/schemas/ModelCandidate' + scoring_params: + additionalProperties: + discriminator: + mapping: + basic: '#/components/schemas/BasicScoringFnParams' + llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' + regex_parser: '#/components/schemas/RegexParserScoringFnParams' + propertyName: type + oneOf: + - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' + title: LLMAsJudgeScoringFnParams + - $ref: '#/components/schemas/RegexParserScoringFnParams' + title: RegexParserScoringFnParams + - $ref: '#/components/schemas/BasicScoringFnParams' + title: BasicScoringFnParams + title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams + description: Map between scoring function id and parameters for each scoring function you want to run + title: Scoring Params + type: object + num_examples: + anyOf: + - type: integer + - type: 'null' + description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated + nullable: true + required: + - eval_candidate + title: BenchmarkConfig + type: object + ScoringResult: + description: A scoring result for a single row. + properties: + score_rows: + items: + additionalProperties: true + type: object + title: Score Rows + type: array + aggregated_results: + additionalProperties: true + title: Aggregated Results + type: object + required: + - score_rows + - aggregated_results + title: ScoringResult + type: object + EvaluateResponse: + description: The response from an evaluation. + properties: + generations: + items: + additionalProperties: true + type: object + title: Generations + type: array + scores: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Scores + type: object + required: + - generations + - scores + title: EvaluateResponse + type: object + ExpiresAfter: + description: |- + Control expiration of uploaded files. + + Params: + - anchor, must be "created_at" + - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) + properties: + anchor: + const: created_at + title: Anchor + type: string + seconds: + maximum: 2592000 + minimum: 3600 + title: Seconds + type: integer + required: + - anchor + - seconds + title: ExpiresAfter + type: object + OpenAIFileObject: + description: OpenAI File object as defined in the OpenAI Files API. + properties: + object: + const: file + default: file + title: Object + type: string + id: + title: Id + type: string + bytes: + title: Bytes + type: integer + created_at: + title: Created At + type: integer + expires_at: + title: Expires At + type: integer + filename: + title: Filename + type: string + purpose: + $ref: '#/components/schemas/OpenAIFilePurpose' + required: + - id + - bytes + - created_at + - expires_at + - filename + - purpose + title: OpenAIFileObject + type: object + OpenAIFilePurpose: + description: Valid purpose values for OpenAI Files API. + enum: + - assistants + - batch + title: OpenAIFilePurpose + type: string + ListOpenAIFileResponse: + description: Response for listing files in OpenAI Files API. + properties: + data: + items: + $ref: '#/components/schemas/OpenAIFileObject' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIFileResponse + type: object + OpenAIFileDeleteResponse: + description: Response for deleting a file in OpenAI Files API. + properties: + id: + title: Id + type: string + object: + const: file + default: file + title: Object + type: string + deleted: + title: Deleted + type: boolean + required: + - id + - deleted + title: OpenAIFileDeleteResponse + type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: @@ -13462,6 +8144,304 @@ components: default: int4_weight_int8_dynamic_activation title: Int4QuantizationConfig type: object + OpenAIChatCompletionUsage: + description: Usage information for OpenAI chat completion. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + completion_tokens: + title: Completion Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + prompt_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' + title: OpenAIChatCompletionUsagePromptTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + completion_tokens_details: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' + title: OpenAIChatCompletionUsageCompletionTokensDetails + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + required: + - prompt_tokens + - completion_tokens + - total_tokens + title: OpenAIChatCompletionUsage + type: object + OpenAIChatCompletionUsageCompletionTokensDetails: + description: Token details for output tokens in OpenAI chat completion usage. + properties: + reasoning_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsageCompletionTokensDetails + type: object + OpenAIChatCompletionUsagePromptTokensDetails: + description: Token details for prompt tokens in OpenAI chat completion usage. + properties: + cached_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsagePromptTokensDetails + type: object + OpenAIChoice: + description: A choice from an OpenAI-compatible chat completion response. + properties: + message: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + finish_reason: + title: Finish Reason + type: string + index: + title: Index + type: integer + logprobs: + anyOf: + - $ref: '#/components/schemas/OpenAIChoiceLogprobs' + title: OpenAIChoiceLogprobs + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + required: + - message + - finish_reason + - index + title: OpenAIChoice + type: object + OpenAIChoiceLogprobs: + description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. + properties: + content: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + refusal: + anyOf: + - items: + $ref: '#/components/schemas/OpenAITokenLogProb' + type: array + - type: 'null' + nullable: true + title: OpenAIChoiceLogprobs + type: object + OpenAICompletionWithInputMessages: + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + input_messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + title: Input Messages + type: array + required: + - id + - choices + - created + - model + - input_messages + title: OpenAICompletionWithInputMessages + type: object + OpenAITokenLogProb: + description: |- + The log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + :top_logprobs: The top log probabilities for the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + top_logprobs: + items: + $ref: '#/components/schemas/OpenAITopLogProb' + title: Top Logprobs + type: array + required: + - token + - logprob + - top_logprobs + title: OpenAITokenLogProb + type: object + OpenAITopLogProb: + description: |- + The top log probability for a token from an OpenAI-compatible chat completion response. + + :token: The token + :bytes: (Optional) The bytes for the token + :logprob: The log probability of the token + properties: + token: + title: Token + type: string + bytes: + anyOf: + - items: + type: integer + type: array + - type: 'null' + nullable: true + logprob: + title: Logprob + type: number + required: + - token + - logprob + title: OpenAITopLogProb + type: object + ListOpenAIChatCompletionResponse: + description: Response from listing OpenAI-compatible chat completions. + properties: + data: + items: + $ref: '#/components/schemas/OpenAICompletionWithInputMessages' + title: Data + type: array + has_more: + title: Has More + type: boolean + first_id: + title: First Id + type: string + last_id: + title: Last Id + type: string + object: + const: list + default: list + title: Object + type: string + required: + - data + - has_more + - first_id + - last_id + title: ListOpenAIChatCompletionResponse + type: object + OpenAIChatCompletion: + description: Response from an OpenAI-compatible chat completion request. + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAIChoice' + title: Choices + type: array + object: + const: chat.completion + default: chat.completion + title: Object + type: string + created: + title: Created + type: integer + model: + title: Model + type: string + usage: + anyOf: + - $ref: '#/components/schemas/OpenAIChatCompletionUsage' + title: OpenAIChatCompletionUsage + - type: 'null' + nullable: true + title: OpenAIChatCompletionUsage + required: + - id + - choices + - created + - model + title: OpenAIChatCompletion + type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: @@ -13494,25 +8474,6 @@ components: nullable: true title: OpenAIChoiceDelta type: object - OpenAIChoiceLogprobs: - description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. - properties: - content: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - refusal: - anyOf: - - items: - $ref: '#/components/schemas/OpenAITokenLogProb' - type: array - - type: 'null' - nullable: true - title: OpenAIChoiceLogprobs - type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: @@ -13573,48 +8534,181 @@ components: - model title: OpenAIChatCompletionChunk type: object - OpenAIChoice: - description: A choice from an OpenAI-compatible chat completion response. + OpenAIChatCompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible chat completion endpoint. properties: - message: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - finish_reason: - title: Finish Reason + model: + title: Model type: string - index: - title: Index - type: integer - logprobs: + messages: + items: + discriminator: + mapping: + assistant: '#/components/schemas/OpenAIAssistantMessageParam' + developer: '#/components/schemas/OpenAIDeveloperMessageParam' + system: '#/components/schemas/OpenAISystemMessageParam' + tool: '#/components/schemas/OpenAIToolMessageParam' + user: '#/components/schemas/OpenAIUserMessageParam' + propertyName: role + oneOf: + - $ref: '#/components/schemas/OpenAIUserMessageParam' + title: OpenAIUserMessageParam + - $ref: '#/components/schemas/OpenAISystemMessageParam' + title: OpenAISystemMessageParam + - $ref: '#/components/schemas/OpenAIAssistantMessageParam' + title: OpenAIAssistantMessageParam + - $ref: '#/components/schemas/OpenAIToolMessageParam' + title: OpenAIToolMessageParam + - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' + title: OpenAIDeveloperMessageParam + title: OpenAIUserMessageParam | ... (5 variants) + minItems: 1 + title: Messages + type: array + frequency_penalty: anyOf: - - $ref: '#/components/schemas/OpenAIChoiceLogprobs' - title: OpenAIChoiceLogprobs + - type: number + - type: 'null' + nullable: true + function_call: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + functions: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_completion_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + parallel_tool_calls: + anyOf: + - type: boolean + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + response_format: + anyOf: + - discriminator: + mapping: + json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' + json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' + text: '#/components/schemas/OpenAIResponseFormatText' + propertyName: type + oneOf: + - $ref: '#/components/schemas/OpenAIResponseFormatText' + title: OpenAIResponseFormatText + - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' + title: OpenAIResponseFormatJSONSchema + - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' + title: OpenAIResponseFormatJSONObject + title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject + - type: 'null' + title: Response Format + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + tool_choice: + anyOf: + - type: string + - additionalProperties: true + type: object + - type: 'null' + title: string | object + nullable: true + tools: + anyOf: + - items: + additionalProperties: true + type: object + type: array + - type: 'null' + nullable: true + top_logprobs: + anyOf: + - type: integer + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string - type: 'null' nullable: true - title: OpenAIChoiceLogprobs required: - - message - - finish_reason - - index - title: OpenAIChoice + - model + - messages + title: OpenAIChatCompletionRequestWithExtraBody type: object OpenAICompletionChoice: description: |- @@ -13647,6 +8741,42 @@ components: - index title: OpenAICompletionChoice type: object + OpenAICompletion: + description: |- + Response from an OpenAI-compatible completion request. + + :id: The ID of the completion + :choices: List of choices + :created: The Unix timestamp in seconds when the completion was created + :model: The model that was used to generate the completion + :object: The object type, which will be "text_completion" + properties: + id: + title: Id + type: string + choices: + items: + $ref: '#/components/schemas/OpenAICompletionChoice' + title: Choices + type: array + created: + title: Created + type: integer + model: + title: Model + type: string + object: + const: text_completion + default: text_completion + title: Object + type: string + required: + - id + - choices + - created + - model + title: OpenAICompletion + type: object OpenAICompletionLogprobs: description: |- The log probabilities for the tokens in the message from an OpenAI-compatible completion response. @@ -13688,6 +8818,247 @@ components: nullable: true title: OpenAICompletionLogprobs type: object + OpenAICompletionRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible completion endpoint. + properties: + model: + title: Model + type: string + prompt: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - items: + type: integer + type: array + title: list[integer] + - items: + items: + type: integer + type: array + type: array + title: list[array] + title: string | ... (4 variants) + best_of: + anyOf: + - type: integer + - type: 'null' + nullable: true + echo: + anyOf: + - type: boolean + - type: 'null' + nullable: true + frequency_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + logit_bias: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + logprobs: + anyOf: + - type: boolean + - type: 'null' + nullable: true + max_tokens: + anyOf: + - type: integer + - type: 'null' + nullable: true + n: + anyOf: + - type: integer + - type: 'null' + nullable: true + presence_penalty: + anyOf: + - type: number + - type: 'null' + nullable: true + seed: + anyOf: + - type: integer + - type: 'null' + nullable: true + stop: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + - type: 'null' + title: string | list[string] + nullable: true + stream: + anyOf: + - type: boolean + - type: 'null' + nullable: true + stream_options: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + temperature: + anyOf: + - type: number + - type: 'null' + nullable: true + top_p: + anyOf: + - type: number + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + suffix: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - prompt + title: OpenAICompletionRequestWithExtraBody + type: object + OpenAIEmbeddingData: + description: A single embedding data object from an OpenAI-compatible embeddings response. + properties: + object: + const: embedding + default: embedding + title: Object + type: string + embedding: + anyOf: + - items: + type: number + type: array + title: list[number] + - type: string + title: list[number] | string + index: + title: Index + type: integer + required: + - embedding + - index + title: OpenAIEmbeddingData + type: object + OpenAIEmbeddingUsage: + description: Usage information for an OpenAI-compatible embeddings response. + properties: + prompt_tokens: + title: Prompt Tokens + type: integer + total_tokens: + title: Total Tokens + type: integer + required: + - prompt_tokens + - total_tokens + title: OpenAIEmbeddingUsage + type: object + OpenAIEmbeddingsRequestWithExtraBody: + additionalProperties: true + description: Request parameters for OpenAI-compatible embeddings endpoint. + properties: + model: + title: Model + type: string + input: + anyOf: + - type: string + - items: + type: string + type: array + title: list[string] + title: string | list[string] + encoding_format: + anyOf: + - type: string + - type: 'null' + default: float + dimensions: + anyOf: + - type: integer + - type: 'null' + nullable: true + user: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - model + - input + title: OpenAIEmbeddingsRequestWithExtraBody + type: object + OpenAIEmbeddingsResponse: + description: Response from an OpenAI-compatible embeddings request. + properties: + object: + const: list + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/OpenAIEmbeddingData' + title: Data + type: array + model: + title: Model + type: string + usage: + $ref: '#/components/schemas/OpenAIEmbeddingUsage' + required: + - data + - model + - usage + title: OpenAIEmbeddingsResponse + type: object + RerankData: + description: A single rerank result from a reranking response. + properties: + index: + title: Index + type: integer + relevance_score: + title: Relevance Score + type: number + required: + - index + - relevance_score + title: RerankData + type: object + RerankResponse: + description: Response from a reranking request. + properties: + data: + items: + $ref: '#/components/schemas/RerankData' + title: Data + type: array + required: + - data + title: RerankResponse + type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: @@ -13817,6 +9188,233 @@ components: - content title: UserMessage type: object + HealthStatus: + enum: + - OK + - Error + - Not Implemented + title: HealthStatus + type: string + HealthInfo: + description: Health status information for the service. + properties: + status: + $ref: '#/components/schemas/HealthStatus' + required: + - status + title: HealthInfo + type: object + RouteInfo: + description: Information about an API route including its path, method, and implementing providers. + properties: + route: + title: Route + type: string + method: + title: Method + type: string + provider_types: + items: + type: string + title: Provider Types + type: array + required: + - route + - method + - provider_types + title: RouteInfo + type: object + ListRoutesResponse: + description: Response containing a list of all available API routes. + properties: + data: + items: + $ref: '#/components/schemas/RouteInfo' + title: Data + type: array + required: + - data + title: ListRoutesResponse + type: object + VersionInfo: + description: Version information for the service. + properties: + version: + title: Version + type: string + required: + - version + title: VersionInfo + type: object + OpenAIModel: + description: |- + A model from OpenAI. + + :id: The ID of the model + :object: The object type, which will be "model" + :created: The Unix timestamp in seconds when the model was created + :owned_by: The owner of the model + :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata + properties: + id: + title: Id + type: string + object: + const: model + default: model + title: Object + type: string + created: + title: Created + type: integer + owned_by: + title: Owned By + type: string + custom_metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - id + - created + - owned_by + title: OpenAIModel + type: object + DPOLossType: + enum: + - sigmoid + - hinge + - ipo + - kto_pair + title: DPOLossType + type: string + DPOAlignmentConfig: + description: Configuration for Direct Preference Optimization (DPO) alignment. + properties: + beta: + title: Beta + type: number + loss_type: + $ref: '#/components/schemas/DPOLossType' + default: sigmoid + required: + - beta + title: DPOAlignmentConfig + type: object + DatasetFormat: + description: Format of the training dataset. + enum: + - instruct + - dialog + title: DatasetFormat + type: string + DataConfig: + description: Configuration for training data and data loading. + properties: + dataset_id: + title: Dataset Id + type: string + batch_size: + title: Batch Size + type: integer + shuffle: + title: Shuffle + type: boolean + data_format: + $ref: '#/components/schemas/DatasetFormat' + validation_dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + packed: + anyOf: + - type: boolean + - type: 'null' + default: false + train_on_input: + anyOf: + - type: boolean + - type: 'null' + default: false + required: + - dataset_id + - batch_size + - shuffle + - data_format + title: DataConfig + type: object + EfficiencyConfig: + description: Configuration for memory and compute efficiency optimizations. + properties: + enable_activation_checkpointing: + anyOf: + - type: boolean + - type: 'null' + default: false + enable_activation_offloading: + anyOf: + - type: boolean + - type: 'null' + default: false + memory_efficient_fsdp_wrap: + anyOf: + - type: boolean + - type: 'null' + default: false + fsdp_cpu_offload: + anyOf: + - type: boolean + - type: 'null' + default: false + title: EfficiencyConfig + type: object + OptimizerType: + description: Available optimizer algorithms for training. + enum: + - adam + - adamw + - sgd + title: OptimizerType + type: string + OptimizerConfig: + description: Configuration parameters for the optimization algorithm. + properties: + optimizer_type: + $ref: '#/components/schemas/OptimizerType' + lr: + title: Lr + type: number + weight_decay: + title: Weight Decay + type: number + num_warmup_steps: + title: Num Warmup Steps + type: integer + required: + - optimizer_type + - lr + - weight_decay + - num_warmup_steps + title: OptimizerConfig + type: object + PostTrainingJobArtifactsResponse: + description: Artifacts of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + title: PostTrainingJobArtifactsResponse + type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: @@ -13833,12 +9431,103 @@ components: - log_lines title: PostTrainingJobLogStream type: object + PostTrainingJobStatusResponse: + description: Status of a finetuning job. + properties: + job_uuid: + title: Job Uuid + type: string + status: + $ref: '#/components/schemas/JobStatus' + scheduled_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + started_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + completed_at: + anyOf: + - format: date-time + type: string + - type: 'null' + nullable: true + resources_allocated: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + checkpoints: + items: + $ref: '#/components/schemas/Checkpoint' + title: Checkpoints + type: array + required: + - job_uuid + - status + title: PostTrainingJobStatusResponse + type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string + TrainingConfig: + description: Comprehensive configuration for the training process. + properties: + n_epochs: + title: N Epochs + type: integer + max_steps_per_epoch: + default: 1 + title: Max Steps Per Epoch + type: integer + gradient_accumulation_steps: + default: 1 + title: Gradient Accumulation Steps + type: integer + max_validation_steps: + anyOf: + - type: integer + - type: 'null' + default: 1 + data_config: + anyOf: + - $ref: '#/components/schemas/DataConfig' + title: DataConfig + - type: 'null' + nullable: true + title: DataConfig + optimizer_config: + anyOf: + - $ref: '#/components/schemas/OptimizerConfig' + title: OptimizerConfig + - type: 'null' + nullable: true + title: OptimizerConfig + efficiency_config: + anyOf: + - $ref: '#/components/schemas/EfficiencyConfig' + title: EfficiencyConfig + - type: 'null' + nullable: true + title: EfficiencyConfig + dtype: + anyOf: + - type: string + - type: 'null' + default: bf16 + required: + - n_epochs + title: TrainingConfig + type: object PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: @@ -13870,167 +9559,258 @@ components: title: Logger Config type: object required: - - job_uuid - - training_config - - hyperparam_search_config - - logger_config - title: SupervisedFineTuneRequest - RegisterModelRequest: + - job_uuid + - finetuned_model + - dataset_id + - validation_dataset_id + - algorithm + - algorithm_config + - optimizer_config + - training_config + - hyperparam_search_config + - logger_config + title: PostTrainingRLHFRequest type: object + Prompt: + description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. properties: - model_id: + prompt: + anyOf: + - type: string + - type: 'null' + description: The system prompt with variable placeholders + nullable: true + version: + description: Version (integer starting at 1, incremented on save) + minimum: 1 + title: Version + type: integer + prompt_id: + description: Unique identifier in format 'pmpt_<48-digit-hash>' + title: Prompt Id type: string - description: The identifier of the model to register. - provider_model_id: + variables: + description: List of variable names that can be used in the prompt template + items: + type: string + title: Variables + type: array + is_default: + default: false + description: Boolean indicating whether this version is the default version + title: Is Default + type: boolean + required: + - version + - prompt_id + title: Prompt + type: object + ProviderInfo: + description: Information about a registered provider including its configuration and health status. + properties: + api: + title: Api type: string - description: >- - The identifier of the model in the provider. provider_id: + title: Provider Id type: string - description: The identifier of the provider. + provider_type: + title: Provider Type + type: string + config: + additionalProperties: true + title: Config + type: object + health: + additionalProperties: true + title: Health + type: object + required: + - api + - provider_id + - provider_type + - config + - health + title: ProviderInfo + type: object + ModerationObjectResults: + description: A moderation object. + properties: + flagged: + title: Flagged + type: boolean + categories: + anyOf: + - additionalProperties: + type: boolean + type: object + - type: 'null' + nullable: true + category_applied_input_types: + anyOf: + - additionalProperties: + items: + type: string + type: array + type: object + - type: 'null' + nullable: true + category_scores: + anyOf: + - additionalProperties: + type: number + type: object + - type: 'null' + nullable: true + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true metadata: + additionalProperties: true + title: Metadata type: object - additionalProperties: - oneOf: - - 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 - title: RegisterModelRequest - 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' - discriminator: - propertyName: type - mapping: - string: '#/components/schemas/StringType' - number: '#/components/schemas/NumberType' - boolean: '#/components/schemas/BooleanType' - array: '#/components/schemas/ArrayType' - object: '#/components/schemas/ObjectType' - json: '#/components/schemas/JsonType' - union: '#/components/schemas/UnionType' - chat_completion_input: '#/components/schemas/ChatCompletionInputType' - completion_input: '#/components/schemas/CompletionInputType' - RegisterScoringFunctionRequest: + - flagged + title: ModerationObjectResults type: object + ModerationObject: + description: A moderation object. properties: - scoring_fn_id: + id: + title: Id type: string - description: >- - The ID of the scoring function to register. - description: + model: + title: Model type: string - description: The description of the scoring function. - return_type: - $ref: '#/components/schemas/ParamType' - 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. - provider_id: - type: string - 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. - additionalProperties: false + results: + items: + $ref: '#/components/schemas/ModerationObjectResults' + title: Results + type: array required: - - scoring_fn_id - - description - - return_type - title: RegisterScoringFunctionRequest - RegisterShieldRequest: + - id + - model + - results + title: ModerationObject type: object + SafetyViolation: + description: Details of a safety violation detected by content moderation. properties: - shield_id: - type: string - description: >- - The identifier of the shield to register. - provider_shield_id: - type: string - description: >- - The identifier of the shield in the provider. - provider_id: - type: string - description: The identifier of the provider. - params: + violation_level: + $ref: '#/components/schemas/ViolationLevel' + user_message: + anyOf: + - type: string + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata type: object - additionalProperties: - oneOf: - - type: 'null' - - type: boolean - - type: number - - type: string - - type: array - - type: object - description: The parameters of the shield. - additionalProperties: false required: - - shield_id - title: RegisterShieldRequest - RegisterToolGroupRequest: + - violation_level + title: SafetyViolation type: object + ViolationLevel: + description: Severity level of a safety violation. + enum: + - info + - warn + - error + title: ViolationLevel + type: string + RunShieldResponse: + description: Response from running a safety shield. + properties: + violation: + anyOf: + - $ref: '#/components/schemas/SafetyViolation' + title: SafetyViolation + - type: 'null' + nullable: true + title: SafetyViolation + title: RunShieldResponse + type: object + ScoreBatchResponse: + description: Response from batch scoring operations on datasets. + properties: + dataset_id: + anyOf: + - type: string + - type: 'null' + nullable: true + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreBatchResponse + type: object + ScoreResponse: + description: The response from scoring. + properties: + results: + additionalProperties: + $ref: '#/components/schemas/ScoringResult' + title: Results + type: object + required: + - results + title: ScoreResponse + type: object + ToolDef: + description: Tool definition used in runtime contexts. properties: toolgroup_id: + anyOf: + - type: string + - type: 'null' + nullable: true + name: + title: Name type: string - 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. - mcp_endpoint: - $ref: '#/components/schemas/URL' - 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. - additionalProperties: false + description: + anyOf: + - type: string + - type: 'null' + nullable: true + input_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + output_schema: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true required: - - toolgroup_id - - provider_id - title: RegisterToolGroupRequest - DataSource: - oneOf: - - $ref: '#/components/schemas/URIDataSource' - - $ref: '#/components/schemas/RowsDataSource' - discriminator: - propertyName: type - mapping: - uri: '#/components/schemas/URIDataSource' - rows: '#/components/schemas/RowsDataSource' - RegisterDatasetRequest: + - name + title: ToolDef + type: object + ListToolDefsResponse: + description: Response containing a list of tool definitions. + properties: + data: + items: + $ref: '#/components/schemas/ToolDef' + title: Data + type: array + required: + - data + title: ListToolDefsResponse type: object ToolGroupInput: description: Input data for registering a tool group. @@ -14059,6 +9839,122 @@ components: - provider_id title: ToolGroupInput type: object + ToolInvocationResult: + description: Result of a tool invocation. + properties: + content: + anyOf: + - type: string + - discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + - items: + discriminator: + mapping: + image: '#/components/schemas/ImageContentItem' + text: '#/components/schemas/TextContentItem' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ImageContentItem' + title: ImageContentItem + - $ref: '#/components/schemas/TextContentItem' + title: TextContentItem + title: ImageContentItem | TextContentItem + type: array + title: list[ImageContentItem | TextContentItem] + - type: 'null' + title: string | list[ImageContentItem | TextContentItem] + nullable: true + error_message: + anyOf: + - type: string + - type: 'null' + nullable: true + error_code: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: ToolInvocationResult + type: object + ChunkMetadata: + description: |- + `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that + will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` + is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. + Use `Chunk.metadata` for metadata that will be used in the context during inference. + properties: + chunk_id: + anyOf: + - type: string + - type: 'null' + nullable: true + document_id: + anyOf: + - type: string + - type: 'null' + nullable: true + source: + anyOf: + - type: string + - type: 'null' + nullable: true + created_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + updated_timestamp: + anyOf: + - type: integer + - type: 'null' + nullable: true + chunk_window: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_tokenizer: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_model: + anyOf: + - type: string + - type: 'null' + nullable: true + chunk_embedding_dimension: + anyOf: + - type: integer + - type: 'null' + nullable: true + content_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata_token_count: + anyOf: + - type: integer + - type: 'null' + nullable: true + title: ChunkMetadata + type: object Chunk: description: A chunk of content that can be inserted into a vector database. properties: @@ -14117,6 +10013,140 @@ components: - chunk_id title: Chunk type: object + OpenAICreateVectorStoreFileBatchRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store file batch with extra_body support. + properties: + file_ids: + items: + type: string + title: File Ids + type: array + attributes: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + required: + - file_ids + title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody + type: object + OpenAICreateVectorStoreRequestWithExtraBody: + additionalProperties: true + description: Request to create a vector store with extra_body support. + properties: + name: + anyOf: + - type: string + - type: 'null' + nullable: true + file_ids: + anyOf: + - items: + type: string + type: array + - type: 'null' + nullable: true + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + chunking_strategy: + anyOf: + - discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + - type: 'null' + title: Chunking Strategy + nullable: true + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + title: OpenAICreateVectorStoreRequestWithExtraBody + type: object + QueryChunksResponse: + description: Response from querying chunks in a vector database. + properties: + chunks: + items: + $ref: '#/components/schemas/Chunk' + title: Chunks + type: array + scores: + items: + type: number + title: Scores + type: array + required: + - chunks + - scores + title: QueryChunksResponse + type: object + VectorStoreContent: + description: Content item from a vector store file or search result. + properties: + type: + const: text + title: Type + type: string + text: + title: Text + type: string + embedding: + anyOf: + - items: + type: number + type: array + - type: 'null' + nullable: true + chunk_metadata: + anyOf: + - $ref: '#/components/schemas/ChunkMetadata' + title: ChunkMetadata + - type: 'null' + nullable: true + title: ChunkMetadata + metadata: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + required: + - type + - text + title: VectorStoreContent + type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: @@ -14148,6 +10178,351 @@ components: type: object title: VectorStoreCreateRequest type: object + VectorStoreDeleteResponse: + description: Response from deleting a vector store. + properties: + id: + title: Id + type: string + object: + default: vector_store.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreDeleteResponse + type: object + VectorStoreFileCounts: + description: File processing status counts for a vector store. + properties: + completed: + title: Completed + type: integer + cancelled: + title: Cancelled + type: integer + failed: + title: Failed + type: integer + in_progress: + title: In Progress + type: integer + total: + title: Total + type: integer + required: + - completed + - cancelled + - failed + - in_progress + - total + title: VectorStoreFileCounts + type: object + VectorStoreFileBatchObject: + description: OpenAI Vector Store File Batch object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file_batch + title: Object + type: string + created_at: + title: Created At + type: integer + vector_store_id: + title: Vector Store Id + type: string + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + required: + - id + - created_at + - vector_store_id + - status + - file_counts + title: VectorStoreFileBatchObject + type: object + VectorStoreFileContentResponse: + description: Represents the parsed content of a vector store file. + properties: + object: + const: vector_store.file_content.page + default: vector_store.file_content.page + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreContent' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true + required: + - data + title: VectorStoreFileContentResponse + type: object + VectorStoreFileDeleteResponse: + description: Response from deleting a vector store file. + properties: + id: + title: Id + type: string + object: + default: vector_store.file.deleted + title: Object + type: string + deleted: + default: true + title: Deleted + type: boolean + required: + - id + title: VectorStoreFileDeleteResponse + type: object + VectorStoreFileLastError: + description: Error information for failed vector store file processing. + properties: + code: + title: Code + type: string + enum: + - server_error + - rate_limit_exceeded + default: server_error + message: + title: Message + type: string + required: + - code + - message + title: VectorStoreFileLastError + type: object + VectorStoreFileObject: + description: OpenAI Vector Store File object. + properties: + id: + title: Id + type: string + object: + default: vector_store.file + title: Object + type: string + attributes: + additionalProperties: true + title: Attributes + type: object + chunking_strategy: + discriminator: + mapping: + auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' + static: '#/components/schemas/VectorStoreChunkingStrategyStatic' + propertyName: type + oneOf: + - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' + title: VectorStoreChunkingStrategyAuto + - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' + title: VectorStoreChunkingStrategyStatic + title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic + created_at: + title: Created At + type: integer + last_error: + anyOf: + - $ref: '#/components/schemas/VectorStoreFileLastError' + title: VectorStoreFileLastError + - type: 'null' + nullable: true + title: VectorStoreFileLastError + status: + title: Status + type: string + enum: + - completed + - in_progress + - cancelled + - failed + default: completed + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + vector_store_id: + title: Vector Store Id + type: string + required: + - id + - chunking_strategy + - created_at + - status + - vector_store_id + title: VectorStoreFileObject + type: object + VectorStoreFilesListInBatchResponse: + description: Response from listing files in a vector store file batch. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreFilesListInBatchResponse + type: object + VectorStoreListFilesResponse: + description: Response from listing files in a vector store. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreFileObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListFilesResponse + type: object + VectorStoreObject: + description: OpenAI Vector Store object. + properties: + id: + title: Id + type: string + object: + default: vector_store + title: Object + type: string + created_at: + title: Created At + type: integer + name: + anyOf: + - type: string + - type: 'null' + nullable: true + usage_bytes: + default: 0 + title: Usage Bytes + type: integer + file_counts: + $ref: '#/components/schemas/VectorStoreFileCounts' + status: + default: completed + title: Status + type: string + expires_after: + anyOf: + - additionalProperties: true + type: object + - type: 'null' + nullable: true + expires_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + last_active_at: + anyOf: + - type: integer + - type: 'null' + nullable: true + metadata: + additionalProperties: true + title: Metadata + type: object + required: + - id + - created_at + - file_counts + title: VectorStoreObject + type: object + VectorStoreListResponse: + description: Response from listing vector stores. + properties: + object: + default: list + title: Object + type: string + data: + items: + $ref: '#/components/schemas/VectorStoreObject' + title: Data + type: array + first_id: + anyOf: + - type: string + - type: 'null' + nullable: true + last_id: + anyOf: + - type: string + - type: 'null' + nullable: true + has_more: + default: false + title: Has More + type: boolean + required: + - data + title: VectorStoreListResponse + type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: @@ -14240,149 +10615,34 @@ components: - content title: VectorStoreSearchResponse type: object - _safety_run_shield_Request: + VectorStoreSearchResponsePage: + description: Paginated response from searching a vector store. properties: - shield_id: - title: Shield Id + object: + default: vector_store.search_results.page + title: Object type: string - messages: + search_query: items: - discriminator: - mapping: - assistant: '#/components/schemas/OpenAIAssistantMessageParam' - developer: '#/components/schemas/OpenAIDeveloperMessageParam' - system: '#/components/schemas/OpenAISystemMessageParam' - tool: '#/components/schemas/OpenAIToolMessageParam' - user: '#/components/schemas/OpenAIUserMessageParam' - propertyName: role - oneOf: - - $ref: '#/components/schemas/OpenAIUserMessageParam' - title: OpenAIUserMessageParam - - $ref: '#/components/schemas/OpenAISystemMessageParam' - title: OpenAISystemMessageParam - - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - title: OpenAIAssistantMessageParam - - $ref: '#/components/schemas/OpenAIToolMessageParam' - title: OpenAIToolMessageParam - - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' - title: OpenAIDeveloperMessageParam - title: OpenAIUserMessageParam | ... (5 variants) - title: Messages + type: string + title: Search Query type: array - params: - additionalProperties: true - title: Params - type: object + data: + items: + $ref: '#/components/schemas/VectorStoreSearchResponse' + title: Data + type: array + has_more: + default: false + title: Has More + type: boolean + next_page: + anyOf: + - type: string + - type: 'null' + nullable: true required: - - shield_id - - messages - - params - title: _safety_run_shield_Request + - search_query + - data + title: VectorStoreSearchResponsePage type: object - OpenAIResponseMessageOutputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - title: OpenAIResponseMessage-Output - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Output' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageOutputOneOf - title: OpenAIResponseMessage-Output | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageOutputUnion - OpenAIResponseMessageInputUnion: - anyOf: - - oneOf: - - $ref: '#/components/schemas/OpenAIResponseMessage-Input' - title: OpenAIResponseMessage-Input - - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - title: OpenAIResponseOutputMessageWebSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - title: OpenAIResponseOutputMessageFileSearchToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - title: OpenAIResponseOutputMessageFunctionToolCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - title: OpenAIResponseOutputMessageMCPCall - - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - title: OpenAIResponseOutputMessageMCPListTools - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - title: OpenAIResponseMCPApprovalRequest - discriminator: - propertyName: type - mapping: - file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - message: '#/components/schemas/OpenAIResponseMessage-Input' - web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - x-stainless-naming: OpenAIResponseMessageInputOneOf - title: OpenAIResponseMessage-Input | ... (7 variants) - - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - title: OpenAIResponseInputFunctionToolCallOutput - - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - title: OpenAIResponseMCPApprovalResponse - title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse - x-stainless-naming: OpenAIResponseMessageInputUnion - responses: - BadRequest400: - description: The request was invalid or malformed - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 400 - title: Bad Request - detail: The request was invalid or malformed - TooManyRequests429: - description: The client has sent too many requests in a given amount of time - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 429 - title: Too Many Requests - detail: You have exceeded the rate limit. Please try again later. - InternalServerError500: - description: The server encountered an unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - status: 500 - title: Internal Server Error - detail: An unexpected error occurred - DefaultError: - description: An error occurred - content: - application/json: - schema: - $ref: '#/components/schemas/Error' diff --git a/scripts/openapi_generator/app.py b/scripts/openapi_generator/app.py index 2f3314b94..bf7f4d70f 100644 --- a/scripts/openapi_generator/app.py +++ b/scripts/openapi_generator/app.py @@ -13,8 +13,8 @@ from typing import Any from fastapi import FastAPI -from llama_stack.apis.datatypes import Api from llama_stack.core.resolver import api_protocol_map +from llama_stack_api import Api from .state import _protocol_methods_cache diff --git a/scripts/openapi_generator/endpoints.py b/scripts/openapi_generator/endpoints.py index 2ccf073e8..f3bf1382e 100644 --- a/scripts/openapi_generator/endpoints.py +++ b/scripts/openapi_generator/endpoints.py @@ -18,7 +18,7 @@ from typing import Annotated, Any, get_args, get_origin from fastapi import FastAPI from pydantic import Field, create_model -from llama_stack.apis.datatypes import Api +from llama_stack_api import Api from . import app as app_module from .state import _dynamic_models, _extra_body_fields diff --git a/scripts/openapi_generator/schema_collection.py b/scripts/openapi_generator/schema_collection.py index 1cf6935f2..465fe0692 100644 --- a/scripts/openapi_generator/schema_collection.py +++ b/scripts/openapi_generator/schema_collection.py @@ -31,7 +31,7 @@ def _import_all_modules_in_package(package_name: str) -> list[Any]: that any register_schema() calls at module level are executed. Args: - package_name: The fully qualified package name (e.g., 'llama_stack.apis') + package_name: The fully qualified package name (e.g., 'llama_stack_api') Returns: List of imported module objects @@ -54,7 +54,7 @@ def _import_all_modules_in_package(package_name: str) -> list[Any]: modules.append(module) # If this is a package, also try to import any .py files directly - # (e.g., llama_stack.apis.scoring_functions.scoring_functions) + # (e.g., llama_stack_api.scoring_functions.scoring_functions) if ispkg: try: # Try importing the module file with the same name as the package @@ -113,11 +113,11 @@ def _ensure_json_schema_types_included(openapi_schema: dict[str, Any]) -> dict[s # Dynamically import all modules in packages that might register schemas # This ensures register_schema() calls execute and populate _registered_schemas # Also collect the modules for later scanning of @json_schema_type decorated classes - apis_modules = _import_all_modules_in_package("llama_stack.apis") + apis_modules = _import_all_modules_in_package("llama_stack_api") _import_all_modules_in_package("llama_stack.core.telemetry") # First, handle registered schemas (union types, etc.) - from llama_stack.schema_utils import _registered_schemas + from llama_stack_api.schema_utils import _registered_schemas for schema_type, registration_info in _registered_schemas.items(): schema_name = registration_info["name"] diff --git a/scripts/openapi_generator/schema_filtering.py b/scripts/openapi_generator/schema_filtering.py index 9426d7a21..108297e9a 100644 --- a/scripts/openapi_generator/schema_filtering.py +++ b/scripts/openapi_generator/schema_filtering.py @@ -10,7 +10,7 @@ Schema filtering and version filtering for OpenAPI generation. from typing import Any -from llama_stack.apis.version import ( +from llama_stack_api.version import ( LLAMA_STACK_API_V1, LLAMA_STACK_API_V1ALPHA, LLAMA_STACK_API_V1BETA, @@ -25,7 +25,7 @@ def _get_all_json_schema_type_names() -> set[str]: This ensures they are included in filtered schemas even if not directly referenced by paths. """ schema_names = set() - apis_modules = schema_collection._import_all_modules_in_package("llama_stack.apis") + apis_modules = schema_collection._import_all_modules_in_package("llama_stack_api") for module in apis_modules: for attr_name in dir(module): try: @@ -43,7 +43,7 @@ def _get_all_json_schema_type_names() -> set[str]: def _get_explicit_schema_names(openapi_schema: dict[str, Any]) -> set[str]: """Get all registered schema names and @json_schema_type decorated model names.""" - from llama_stack.schema_utils import _registered_schemas + from llama_stack_api.schema_utils import _registered_schemas registered_schema_names = {info["name"] for info in _registered_schemas.values()} json_schema_type_names = _get_all_json_schema_type_names() diff --git a/scripts/openapi_generator/state.py b/scripts/openapi_generator/state.py index b7389f07b..b1c8f8edd 100644 --- a/scripts/openapi_generator/state.py +++ b/scripts/openapi_generator/state.py @@ -10,7 +10,7 @@ Shared state for the OpenAPI generator module. from typing import Any -from llama_stack.apis.datatypes import Api +from llama_stack_api import Api # Global list to store dynamic models created during endpoint generation _dynamic_models: list[Any] = [] diff --git a/src/llama_stack/core/library_client.py b/src/llama_stack/core/library_client.py index 5f95fcbdd..d6be7aeca 100644 --- a/src/llama_stack/core/library_client.py +++ b/src/llama_stack/core/library_client.py @@ -19,7 +19,7 @@ import httpx import yaml from fastapi import Response as FastAPIResponse -from llama_stack_api import is_unwrapped_body_param +from llama_stack.core.utils.type_inspection import is_unwrapped_body_param try: from llama_stack_client import ( @@ -51,7 +51,6 @@ from llama_stack.core.telemetry.tracing import CURRENT_TRACE_CONTEXT, end_trace, from llama_stack.core.utils.config import redact_sensitive_fields from llama_stack.core.utils.context import preserve_contexts_async_generator from llama_stack.core.utils.exec import in_notebook -from llama_stack.core.utils.type_inspection import is_unwrapped_body_param from llama_stack.log import get_logger, setup_logging logger = get_logger(name=__name__, category="core") diff --git a/src/llama_stack_api/__init__.py b/src/llama_stack_api/__init__.py index 19b29301b..fed486cb7 100644 --- a/src/llama_stack_api/__init__.py +++ b/src/llama_stack_api/__init__.py @@ -388,27 +388,6 @@ from .shields import ( ) # Import from strong_typing -from .strong_typing.core import JsonType -from .strong_typing.docstring import Docstring, parse_type -from .strong_typing.inspection import ( - get_signature, - is_generic_list, - is_type_optional, - is_type_union, - is_unwrapped_body_param, - unwrap_generic_list, - unwrap_optional_type, - unwrap_union_types, -) -from .strong_typing.name import python_type_to_name -from .strong_typing.schema import ( - JsonSchemaGenerator, - Schema, - SchemaOptions, - StrictJsonType, - get_schema_identifier, -) -from .strong_typing.serialization import json_dump_string, object_to_json from .tools import ( ListToolDefsResponse, ListToolGroupsResponse, diff --git a/uv.lock b/uv.lock index 2dddcb1c8..e7d7458e3 100644 --- a/uv.lock +++ b/uv.lock @@ -1,5 +1,5 @@ version = 1 -revision = 3 +revision = 2 requires-python = ">=3.12" resolution-markers = [ "(python_full_version >= '3.13' and platform_machine != 'aarch64' and sys_platform == 'linux') or (python_full_version >= '3.13' and sys_platform != 'darwin' and sys_platform != 'linux')", @@ -2176,6 +2176,7 @@ dev = [ { name = "black" }, { name = "mypy" }, { name = "nbval" }, + { name = "openapi-spec-validator", specifier = ">=0.7.2" }, { name = "pre-commit", specifier = ">=4.4.0" }, { name = "pytest", specifier = ">=8.4" }, { name = "pytest-asyncio", specifier = ">=1.0" },