mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-04 10:10:36 +00:00
9949 lines
328 KiB
YAML
9949 lines
328 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: Llama Stack API
|
|
description: A comprehensive API for building and deploying AI applications
|
|
version: 1.0.0
|
|
servers:
|
|
- url: https://api.llamastack.com
|
|
description: Production server
|
|
- url: https://staging-api.llamastack.com
|
|
description: Staging server
|
|
paths:
|
|
/v1/batches:
|
|
get:
|
|
tags:
|
|
- Batches
|
|
summary: List all batches for the current user.
|
|
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'
|
|
description: A cursor for pagination; returns batches after this batch ID.
|
|
title: After
|
|
description: A cursor for pagination; returns batches after this batch ID.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
description: Number of batches to return (default 20, max 100).
|
|
default: 20
|
|
title: Limit
|
|
description: Number of batches to return (default 20, max 100).
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListBatchesResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Batches
|
|
summary: Create a new batch for processing multiple API requests.
|
|
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/CreateBatchRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Batch'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/batches/{batch_id}:
|
|
get:
|
|
tags:
|
|
- Batches
|
|
summary: Retrieve information about a specific batch.
|
|
description: Retrieve information about a specific batch.
|
|
operationId: retrieve_batch_v1_batches__batch_id__get
|
|
parameters:
|
|
- name: batch_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the batch to retrieve.
|
|
title: Batch Id
|
|
description: The ID of the batch to retrieve.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Batch'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/batches/{batch_id}/cancel:
|
|
post:
|
|
tags:
|
|
- Batches
|
|
summary: Cancel a batch that is in progress.
|
|
description: Cancel a batch that is in progress.
|
|
operationId: cancel_batch_v1_batches__batch_id__cancel_post
|
|
parameters:
|
|
- name: batch_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the batch to cancel.
|
|
title: Batch Id
|
|
description: The ID of the batch to cancel.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Batch'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/chat/completions:
|
|
get:
|
|
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'
|
|
description: The ID of the last chat completion to return.
|
|
title: After
|
|
description: The ID of the last chat completion to return.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
description: The maximum number of chat completions to return.
|
|
default: 20
|
|
title: Limit
|
|
description: The maximum number of chat completions to return.
|
|
- name: model
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: The model to filter by.
|
|
title: Model
|
|
description: The model to filter by.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/Order'
|
|
- type: 'null'
|
|
description: "The order to sort the chat completions by: 'asc' or 'desc'. Defaults to 'desc'."
|
|
default: desc
|
|
title: Order
|
|
description: "The order to sort the chat completions by: 'asc' or 'desc'. Defaults to 'desc'."
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListOpenAIChatCompletionResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Inference
|
|
summary: Create chat completions.
|
|
description: Create chat completions.
|
|
operationId: openai_chat_completion_v1_chat_completions_post
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/chat/completions/{completion_id}:
|
|
get:
|
|
tags:
|
|
- Inference
|
|
summary: Get chat completion.
|
|
description: Get chat completion.
|
|
operationId: get_chat_completion_v1_chat_completions__completion_id__get
|
|
parameters:
|
|
- name: completion_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: ID of the chat completion.
|
|
title: Completion Id
|
|
description: ID of the chat completion.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAICompletionWithInputMessages'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/completions:
|
|
post:
|
|
tags:
|
|
- Inference
|
|
summary: Create completion.
|
|
description: Create completion.
|
|
operationId: openai_completion_v1_completions_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAICompletion'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/conversations:
|
|
post:
|
|
tags:
|
|
- Conversations
|
|
summary: Create a conversation
|
|
description: Create a conversation
|
|
operationId: create_conversation_v1_conversations_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationCreateRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Conversation'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/conversations/{conversation_id}:
|
|
delete:
|
|
tags:
|
|
- Conversations
|
|
summary: Delete a conversation
|
|
description: Delete a conversation with the given ID
|
|
operationId: openai_delete_conversation_v1_conversations__conversation_id__delete
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationDeletedResource'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Conversations
|
|
summary: Retrieve a conversation
|
|
description: Get a conversation with the given ID
|
|
operationId: get_conversation_v1_conversations__conversation_id__get
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Conversation'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Conversations
|
|
summary: Update a conversation
|
|
description: Update a conversation's metadata with the given ID
|
|
operationId: update_conversation_v1_conversations__conversation_id__post
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationUpdateRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Conversation'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/conversations/{conversation_id}/items:
|
|
get:
|
|
tags:
|
|
- Conversations
|
|
summary: List items
|
|
description: List items in the conversation
|
|
operationId: list_items_v1_conversations__conversation_id__items_get
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
- name: after
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: An item ID to list items after, used in pagination
|
|
title: After
|
|
description: An item ID to list items after, used in pagination
|
|
- name: include
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: array
|
|
items:
|
|
$ref: '#/components/schemas/ConversationItemInclude'
|
|
- type: 'null'
|
|
description: Specify additional output data to include in the response
|
|
title: Include
|
|
description: Specify additional output data to include in the response
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
description: A limit on the number of objects to be returned (1-100, default 20)
|
|
title: Limit
|
|
description: A limit on the number of objects to be returned (1-100, default 20)
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- enum:
|
|
- asc
|
|
- desc
|
|
type: string
|
|
- type: 'null'
|
|
description: The order to return items in (asc or desc, default desc)
|
|
title: Order
|
|
description: The order to return items in (asc or desc, default desc)
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationItemList'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Conversations
|
|
summary: Create items
|
|
description: Create items in the conversation
|
|
operationId: add_items_v1_conversations__conversation_id__items_post
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationItemCreateRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationItemList'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/conversations/{conversation_id}/items/{item_id}:
|
|
delete:
|
|
tags:
|
|
- Conversations
|
|
summary: Delete an item
|
|
description: Delete a conversation item
|
|
operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
- name: item_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The item identifier
|
|
title: Item Id
|
|
description: The item identifier
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ConversationItemDeletedResource'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Conversations
|
|
summary: Retrieve an item
|
|
description: Retrieve a conversation item
|
|
operationId: retrieve_v1_conversations__conversation_id__items__item_id__get
|
|
parameters:
|
|
- name: conversation_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The conversation identifier
|
|
title: Conversation Id
|
|
description: The conversation identifier
|
|
- name: item_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The item identifier
|
|
title: Item Id
|
|
description: The item identifier
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
message: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
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'
|
|
title: Response Retrieve V1 Conversations Conversation Id Items Item Id Get
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/embeddings:
|
|
post:
|
|
tags:
|
|
- Inference
|
|
summary: Create embeddings.
|
|
description: Create embeddings.
|
|
operationId: openai_embeddings_v1_embeddings_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIEmbeddingsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/files:
|
|
get:
|
|
tags:
|
|
- Files
|
|
summary: List files.
|
|
description: 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'
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
title: After
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
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.
|
|
default: 10000
|
|
title: Limit
|
|
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.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/Order'
|
|
- type: 'null'
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
default: desc
|
|
title: Order
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
- name: purpose
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIFilePurpose'
|
|
- type: 'null'
|
|
description: Only return files with the given purpose.
|
|
title: Purpose
|
|
description: Only return files with the given purpose.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListOpenAIFileResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Files
|
|
summary: Upload file.
|
|
description: Upload a file that can be used across various endpoints.
|
|
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: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIFileObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/files/{file_id}:
|
|
delete:
|
|
tags:
|
|
- Files
|
|
summary: Delete file.
|
|
description: Delete a file.
|
|
operationId: openai_delete_file_v1_files__file_id__delete
|
|
parameters:
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to use for this request.
|
|
title: File Id
|
|
description: The ID of the file to use for this request.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIFileDeleteResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Files
|
|
summary: Retrieve file.
|
|
description: Returns information about a specific file.
|
|
operationId: openai_retrieve_file_v1_files__file_id__get
|
|
parameters:
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to use for this request.
|
|
title: File Id
|
|
description: The ID of the file to use for this request.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIFileObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/files/{file_id}/content:
|
|
get:
|
|
tags:
|
|
- Files
|
|
summary: Retrieve file content.
|
|
description: Returns the contents of the specified file.
|
|
operationId: openai_retrieve_file_content_v1_files__file_id__content_get
|
|
parameters:
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to use for this request.
|
|
title: File Id
|
|
description: The ID of the file to use for this request.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/health:
|
|
get:
|
|
tags:
|
|
- Inspect
|
|
summary: Get health status.
|
|
description: Get the current health status of the service.
|
|
operationId: health_v1_health_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HealthInfo'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/inspect/routes:
|
|
get:
|
|
tags:
|
|
- Inspect
|
|
summary: List routes.
|
|
description: List all available API routes with their methods and implementing providers.
|
|
operationId: list_routes_v1_inspect_routes_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListRoutesResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/models:
|
|
get:
|
|
tags:
|
|
- Models
|
|
summary: List all models.
|
|
description: List all models registered in Llama Stack.
|
|
operationId: list_models_v1_models_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListModelsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Models
|
|
summary: Register model.
|
|
description: Register a new model in Llama Stack.
|
|
operationId: register_model_v1_models_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterModelRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Model'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/models/{model_id}:
|
|
delete:
|
|
tags:
|
|
- Models
|
|
summary: Unregister model.
|
|
description: Unregister a model from Llama Stack.
|
|
operationId: unregister_model_v1_models__model_id__delete
|
|
parameters:
|
|
- name: model_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the model to unregister.
|
|
title: Model Id
|
|
description: The identifier of the model to unregister.
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Models
|
|
summary: Get model.
|
|
description: Get a model by its identifier.
|
|
operationId: get_model_v1_models__model_id__get
|
|
parameters:
|
|
- name: model_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the model to get.
|
|
title: Model Id
|
|
description: The identifier of the model to get.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Model'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/moderations:
|
|
post:
|
|
tags:
|
|
- Safety
|
|
summary: Create moderation.
|
|
description: Classifies if text and/or image inputs are potentially harmful.
|
|
operationId: run_moderation_v1_moderations_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RunModerationRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ModerationObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/prompts:
|
|
get:
|
|
tags:
|
|
- Prompts
|
|
summary: List all prompts
|
|
description: List all prompts registered in Llama Stack
|
|
operationId: list_prompts_v1_prompts_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListPromptsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Prompts
|
|
summary: Create prompt
|
|
description: Create a new prompt
|
|
operationId: create_prompt_v1_prompts_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreatePromptRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Prompt'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/prompts/{prompt_id}:
|
|
delete:
|
|
tags:
|
|
- Prompts
|
|
summary: Delete prompt
|
|
description: Delete a prompt
|
|
operationId: delete_prompt_v1_prompts__prompt_id__delete
|
|
parameters:
|
|
- name: prompt_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the prompt to delete
|
|
title: Prompt Id
|
|
description: The identifier of the prompt to delete
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Prompts
|
|
summary: Get prompt
|
|
description: Get a prompt by its identifier and optional version
|
|
operationId: get_prompt_v1_prompts__prompt_id__get
|
|
parameters:
|
|
- name: prompt_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the prompt to get
|
|
title: Prompt Id
|
|
description: The identifier of the prompt to get
|
|
- name: version
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
description: The version of the prompt to get (defaults to latest)
|
|
title: Version
|
|
description: The version of the prompt to get (defaults to latest)
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Prompt'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Prompts
|
|
summary: Update prompt
|
|
description: Update an existing prompt (increments version)
|
|
operationId: update_prompt_v1_prompts__prompt_id__post
|
|
parameters:
|
|
- name: prompt_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the prompt to update
|
|
title: Prompt Id
|
|
description: The identifier of the prompt to update
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UpdatePromptRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Prompt'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/prompts/{prompt_id}/set-default-version:
|
|
post:
|
|
tags:
|
|
- Prompts
|
|
summary: Set prompt version
|
|
description: Set which version of a prompt should be the default in get_prompt (latest)
|
|
operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post
|
|
parameters:
|
|
- name: prompt_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the prompt
|
|
title: Prompt Id
|
|
description: The identifier of the prompt
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SetDefaultVersionRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Prompt'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/prompts/{prompt_id}/versions:
|
|
get:
|
|
tags:
|
|
- Prompts
|
|
summary: List prompt versions
|
|
description: List all versions of a specific prompt
|
|
operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get
|
|
parameters:
|
|
- name: prompt_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the prompt to list versions for
|
|
title: Prompt Id
|
|
description: The identifier of the prompt to list versions for
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListPromptsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/providers:
|
|
get:
|
|
tags:
|
|
- Providers
|
|
summary: List providers
|
|
description: List all available providers
|
|
operationId: list_providers_v1_providers_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListProvidersResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/providers/{provider_id}:
|
|
get:
|
|
tags:
|
|
- Providers
|
|
summary: Get provider
|
|
description: Get detailed information about a specific provider
|
|
operationId: inspect_provider_v1_providers__provider_id__get
|
|
parameters:
|
|
- name: provider_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the provider to inspect
|
|
title: Provider Id
|
|
description: The ID of the provider to inspect
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ProviderInfo'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/responses:
|
|
get:
|
|
tags:
|
|
- Agents
|
|
summary: List all 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'
|
|
description: The ID of the last response to return.
|
|
title: After
|
|
description: The ID of the last response to return.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
description: The number of responses to return.
|
|
default: 50
|
|
title: Limit
|
|
description: The number of responses to return.
|
|
- name: model
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: The model to filter responses by.
|
|
title: Model
|
|
description: The model to filter responses by.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/Order'
|
|
- type: 'null'
|
|
description: The order to sort responses by when sorted by created_at ('asc' or 'desc').
|
|
default: desc
|
|
title: Order
|
|
description: The order to sort responses by when sorted by created_at ('asc' or 'desc').
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListOpenAIResponseObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Agents
|
|
summary: Create a model response.
|
|
description: Create a model response.
|
|
operationId: create_openai_response_v1_responses_post
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateOpenAIResponseRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/responses/{response_id}:
|
|
delete:
|
|
tags:
|
|
- Agents
|
|
summary: Delete a response.
|
|
description: Delete a response.
|
|
operationId: delete_openai_response_v1_responses__response_id__delete
|
|
parameters:
|
|
- name: response_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the OpenAI response to delete.
|
|
title: Response Id
|
|
description: The ID of the OpenAI response to delete.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIDeleteResponseObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Agents
|
|
summary: Get a model response.
|
|
description: Get a model response.
|
|
operationId: get_openai_response_v1_responses__response_id__get
|
|
parameters:
|
|
- name: response_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the OpenAI response to retrieve.
|
|
title: Response Id
|
|
description: The ID of the OpenAI response to retrieve.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAIResponseObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/responses/{response_id}/input_items:
|
|
get:
|
|
tags:
|
|
- Agents
|
|
summary: List input items.
|
|
description: List input items.
|
|
operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get
|
|
parameters:
|
|
- name: response_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the response to retrieve input items for.
|
|
title: Response Id
|
|
description: The ID of the response to retrieve input items for.
|
|
- name: after
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: An item ID to list items after, used for pagination.
|
|
title: After
|
|
description: An item ID to list items after, used for pagination.
|
|
- name: before
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: An item ID to list items before, used for pagination.
|
|
title: Before
|
|
description: An item ID to list items before, used for pagination.
|
|
- name: include
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: array
|
|
items:
|
|
type: string
|
|
- type: 'null'
|
|
description: Additional fields to include in the response.
|
|
title: Include
|
|
description: Additional fields to include in the response.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
- type: 'null'
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
default: 20
|
|
title: Limit
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/Order'
|
|
- type: 'null'
|
|
description: The order to return the input items in. Default is desc.
|
|
default: desc
|
|
title: Order
|
|
description: The order to return the input items in. Default is desc.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListOpenAIResponseInputItem'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/safety/run-shield:
|
|
post:
|
|
tags:
|
|
- Safety
|
|
summary: Run shield.
|
|
description: Run a shield.
|
|
operationId: run_shield_v1_safety_run_shield_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RunShieldRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RunShieldResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/scoring-functions:
|
|
get:
|
|
tags:
|
|
- Scoring Functions
|
|
summary: List all scoring functions
|
|
description: List all scoring functions
|
|
operationId: list_scoring_functions_v1_scoring_functions_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListScoringFunctionsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Scoring Functions
|
|
summary: Register a scoring function
|
|
description: Register a scoring function
|
|
operationId: register_scoring_function_v1_scoring_functions_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterScoringFunctionRequest'
|
|
required: true
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/scoring-functions/{scoring_fn_id}:
|
|
delete:
|
|
tags:
|
|
- Scoring Functions
|
|
summary: Unregister a scoring function
|
|
description: Unregister a scoring function
|
|
operationId: unregister_scoring_function_v1_scoring_functions__scoring_fn_id__delete
|
|
parameters:
|
|
- name: scoring_fn_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the scoring function to unregister
|
|
title: Scoring Fn Id
|
|
description: The ID of the scoring function to unregister
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Scoring Functions
|
|
summary: Get a scoring function by its ID
|
|
description: Get a scoring function by its ID
|
|
operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get
|
|
parameters:
|
|
- name: scoring_fn_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the scoring function to get
|
|
title: Scoring Fn Id
|
|
description: The ID of the scoring function to get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoringFn'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/scoring/score:
|
|
post:
|
|
tags:
|
|
- Scoring
|
|
summary: Score a list of rows
|
|
description: Score a list of rows
|
|
operationId: score_v1_scoring_score_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/scoring/score-batch:
|
|
post:
|
|
tags:
|
|
- Scoring
|
|
summary: Score a batch of rows
|
|
description: Score a batch of rows from a dataset
|
|
operationId: score_batch_v1_scoring_score_batch_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreBatchRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ScoreBatchResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/shields:
|
|
get:
|
|
tags:
|
|
- Shields
|
|
summary: List all shields
|
|
description: List all shields
|
|
operationId: list_shields_v1_shields_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListShieldsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Shields
|
|
summary: Register a shield
|
|
description: Register a shield
|
|
operationId: register_shield_v1_shields_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterShieldRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Shield'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/shields/{identifier}:
|
|
delete:
|
|
tags:
|
|
- Shields
|
|
summary: Unregister a shield
|
|
description: Unregister a shield
|
|
operationId: unregister_shield_v1_shields__identifier__delete
|
|
parameters:
|
|
- name: identifier
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the shield to unregister
|
|
title: Identifier
|
|
description: The identifier of the shield to unregister
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Shields
|
|
summary: Get a shield by its identifier
|
|
description: Get a shield by its identifier
|
|
operationId: get_shield_v1_shields__identifier__get
|
|
parameters:
|
|
- name: identifier
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The identifier of the shield to get
|
|
title: Identifier
|
|
description: The identifier of the shield to get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Shield'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/tool-runtime/invoke:
|
|
post:
|
|
tags:
|
|
- Tool Runtime
|
|
summary: Run a tool with the given arguments
|
|
description: Run a tool with the given arguments
|
|
operationId: invoke_tool_v1_tool_runtime_invoke_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/InvokeToolRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ToolInvocationResult'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/tool-runtime/list-tools:
|
|
get:
|
|
tags:
|
|
- Tool Runtime
|
|
summary: List all tools in the runtime
|
|
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'
|
|
description: The ID of the tool group to list tools for
|
|
title: Tool Group Id
|
|
description: The ID of the tool group to list tools for
|
|
- name: mcp_endpoint
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: The MCP endpoint URL to use for the tool group
|
|
title: Mcp Endpoint
|
|
description: The MCP endpoint URL to use for the tool group
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListToolDefsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/tool-runtime/rag-tool/insert:
|
|
post:
|
|
tags:
|
|
- Tool Runtime
|
|
summary: Insert documents into the RAG system.
|
|
description: Index documents so they can be used by the RAG system.
|
|
operationId: rag_tool_insert_v1_tool_runtime_rag_tool_insert_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Body_rag_tool_insert_v1_tool_runtime_rag_tool_insert_post'
|
|
required: true
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/tool-runtime/rag-tool/query:
|
|
post:
|
|
tags:
|
|
- Tool Runtime
|
|
summary: Query the RAG system for context.
|
|
description: Query the RAG system for context; typically invoked by the agent.
|
|
operationId: rag_tool_query_v1_tool_runtime_rag_tool_query_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Body_rag_tool_query_v1_tool_runtime_rag_tool_query_post'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RAGQueryResult'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/toolgroups:
|
|
get:
|
|
tags:
|
|
- Tool Groups
|
|
summary: List tool groups
|
|
description: List tool groups with optional provider
|
|
operationId: list_tool_groups_v1_toolgroups_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListToolGroupsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Tool Groups
|
|
summary: Register a tool group
|
|
description: Register a tool group
|
|
operationId: register_tool_group_v1_toolgroups_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RegisterToolGroupRequest'
|
|
required: true
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/toolgroups/{toolgroup_id}:
|
|
delete:
|
|
tags:
|
|
- Tool Groups
|
|
summary: Unregister a tool group
|
|
description: Unregister a tool group
|
|
operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete
|
|
parameters:
|
|
- name: toolgroup_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the tool group to unregister
|
|
title: Toolgroup Id
|
|
description: The ID of the tool group to unregister
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Tool Groups
|
|
summary: Get a tool group by its ID
|
|
description: Get a tool group by its ID
|
|
operationId: get_tool_group_v1_toolgroups__toolgroup_id__get
|
|
parameters:
|
|
- name: toolgroup_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the tool group to get
|
|
title: Toolgroup Id
|
|
description: The ID of the tool group to get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ToolGroup'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/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'
|
|
description: The ID of the tool group to list tools for
|
|
title: Toolgroup Id
|
|
description: The ID of the tool group to list tools for
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListToolDefsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/tools/{tool_name}:
|
|
get:
|
|
tags:
|
|
- Tool Groups
|
|
summary: Get a tool by its name
|
|
description: Get a tool by its name
|
|
operationId: get_tool_v1_tools__tool_name__get
|
|
parameters:
|
|
- name: tool_name
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The name of the tool to get
|
|
title: Tool Name
|
|
description: The name of the tool to get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ToolDef'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector-io/insert:
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Insert chunks into a vector database.
|
|
description: Insert chunks into a vector database.
|
|
operationId: insert_chunks_v1_vector_io_insert_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/InsertChunksRequest'
|
|
required: true
|
|
responses:
|
|
'204':
|
|
description: Successful Response
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector-io/query:
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Query chunks from a vector database.
|
|
description: Query chunks from a vector database.
|
|
operationId: query_chunks_v1_vector_io_query_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/QueryChunksRequest'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/QueryChunksResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores:
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: Returns a list of vector stores.
|
|
description: Returns a list of vector stores.
|
|
operationId: openai_list_vector_stores_v1_vector_stores_get
|
|
parameters:
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
- type: 'null'
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
default: 20
|
|
title: Limit
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
default: desc
|
|
title: Order
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
- name: after
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
title: After
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
- name: before
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: A cursor for use in pagination. `before` is an object ID that defines your place in the list.
|
|
title: Before
|
|
description: A cursor for use in pagination. `before` is an object ID that defines your place in the list.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreListResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Creates a vector store.
|
|
description: Creates a vector store.
|
|
operationId: openai_create_vector_store_v1_vector_stores_post
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}:
|
|
delete:
|
|
tags:
|
|
- Vector IO
|
|
summary: Delete a vector store.
|
|
description: Delete a vector store.
|
|
operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to delete.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to delete.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreDeleteResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: Retrieves a vector store.
|
|
description: Retrieves a vector store.
|
|
operationId: openai_retrieve_vector_store_v1_vector_stores__vector_store_id__get
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to retrieve.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to retrieve.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Updates a vector store.
|
|
description: Updates a vector store.
|
|
operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to update.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to update.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreModifyRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/file_batches:
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Create a vector store file batch.
|
|
description: Create a vector store file batch.
|
|
operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to create the file batch for.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to create the file batch for.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileBatchObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}:
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: Retrieve a vector store file batch.
|
|
description: Retrieve a vector store file batch.
|
|
operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file batch.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file batch.
|
|
- name: batch_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file batch to retrieve.
|
|
title: Batch Id
|
|
description: The ID of the file batch to retrieve.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileBatchObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel:
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Cancels a vector store file batch.
|
|
description: Cancels a vector store file batch.
|
|
operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file batch.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file batch.
|
|
- name: batch_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file batch to cancel.
|
|
title: Batch Id
|
|
description: The ID of the file batch to cancel.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileBatchObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files:
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: Returns a list of vector store files in a 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
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file batch.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file batch.
|
|
- name: batch_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file batch to list files from.
|
|
title: Batch Id
|
|
description: The ID of the file batch to list files from.
|
|
- name: after
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
title: After
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
- name: before
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: A cursor for use in pagination. `before` is an object ID that defines your place in the list.
|
|
title: Before
|
|
description: A cursor for use in pagination. `before` is an object ID that defines your place in the list.
|
|
- name: filter
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Filter by file status. One of in_progress, completed, failed, cancelled.
|
|
title: Filter
|
|
description: Filter by file status. One of in_progress, completed, failed, cancelled.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
- type: 'null'
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
default: 20
|
|
title: Limit
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
default: desc
|
|
title: Order
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFilesListInBatchResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/files:
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: List files in a vector store.
|
|
description: List files in a vector store.
|
|
operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to list files from.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to list files from.
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 100
|
|
minimum: 1
|
|
- type: 'null'
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
default: 20
|
|
title: Limit
|
|
description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
|
|
- name: order
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
default: desc
|
|
title: Order
|
|
description: Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.
|
|
- name: after
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
title: After
|
|
description: A cursor for use in pagination. `after` is an object ID that defines your place in the list.
|
|
- name: before
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
description: A cursor for use in pagination. `before` is an object ID that defines your place in the list.
|
|
title: Before
|
|
description: A cursor for use in pagination. `before` is an object ID that defines your place in the list.
|
|
- name: filter
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- const: completed
|
|
type: string
|
|
- const: in_progress
|
|
type: string
|
|
- const: cancelled
|
|
type: string
|
|
- const: failed
|
|
type: string
|
|
- type: 'null'
|
|
description: Filter by file status to only return files with the specified status.
|
|
title: Filter
|
|
description: Filter by file status to only return files with the specified status.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreListFilesResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Attach a file to a 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
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to attach the file to.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to attach the file to.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Body_openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/files/{file_id}:
|
|
delete:
|
|
tags:
|
|
- Vector IO
|
|
summary: Delete a vector store file.
|
|
description: Delete a vector store file.
|
|
operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file to delete.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file to delete.
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to delete.
|
|
title: File Id
|
|
description: The ID of the file to delete.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileDeleteResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: Retrieves a vector store file.
|
|
description: Retrieves a vector store file.
|
|
operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file to retrieve.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file to retrieve.
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to retrieve.
|
|
title: File Id
|
|
description: The ID of the file to retrieve.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Updates a vector store file.
|
|
description: Updates a vector store file.
|
|
operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file to update.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file to update.
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to update.
|
|
title: File Id
|
|
description: The ID of the file to update.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
description: The updated key-value attributes to store with the file.
|
|
title: Attributes
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileObject'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/files/{file_id}/content:
|
|
get:
|
|
tags:
|
|
- Vector IO
|
|
summary: Retrieves the contents of a vector store file.
|
|
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
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store containing the file to retrieve.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store containing the file to retrieve.
|
|
- name: file_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the file to retrieve.
|
|
title: File Id
|
|
description: The ID of the file to retrieve.
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreFileContentsResponse'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/vector_stores/{vector_store_id}/search:
|
|
post:
|
|
tags:
|
|
- Vector IO
|
|
summary: Search for chunks in a vector store.
|
|
description: Search for chunks in a vector store.
|
|
operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post
|
|
parameters:
|
|
- name: vector_store_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The ID of the vector store to search.
|
|
title: Vector Store Id
|
|
description: The ID of the vector store to search.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Body_openai_search_vector_store_v1_vector_stores__vector_store_id__search_post'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VectorStoreSearchResponsePage'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/v1/version:
|
|
get:
|
|
tags:
|
|
- Inspect
|
|
summary: Get version.
|
|
description: Get the version of the service.
|
|
operationId: version_v1_version_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VersionInfo'
|
|
'400':
|
|
description: The request was invalid or malformed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'429':
|
|
description: The client has sent too many requests in a given amount of time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
'500':
|
|
description: The server encountered an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
default:
|
|
description: An unexpected error occurred.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
components:
|
|
schemas:
|
|
AgentTurnInputType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: agent_turn_input
|
|
title: Type
|
|
default: agent_turn_input
|
|
type: object
|
|
title: AgentTurnInputType
|
|
description: "Parameter type for agent turn input.\n\n:param type: Discriminator type. Always \"agent_turn_input\""
|
|
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'
|
|
title: Tool Names
|
|
description: List of specific tool names that are allowed
|
|
type: object
|
|
title: AllowedToolsFilter
|
|
description: "Filter configuration for restricting which MCP tools can be used.\n\n:param tool_names: (Optional) List of specific tool names that are allowed"
|
|
ApprovalFilter:
|
|
properties:
|
|
always:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Always
|
|
description: List of tool names that always require approval
|
|
never:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Never
|
|
description: List of tool names that never require approval
|
|
type: object
|
|
title: ApprovalFilter
|
|
description: "Filter configuration for MCP tool approval requirements.\n\n:param always: (Optional) List of tool names that always require approval\n:param never: (Optional) List of tool names that never require approval"
|
|
ArrayType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: array
|
|
title: Type
|
|
default: array
|
|
type: object
|
|
title: ArrayType
|
|
description: "Parameter type for array values.\n\n:param type: Discriminator type. Always \"array\""
|
|
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'
|
|
title: Cancelled At
|
|
cancelling_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Cancelling At
|
|
completed_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Completed At
|
|
error_file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Error File Id
|
|
errors:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/Errors'
|
|
- type: 'null'
|
|
expired_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Expired At
|
|
expires_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Expires At
|
|
failed_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Failed At
|
|
finalizing_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Finalizing At
|
|
in_progress_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: In Progress At
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Model
|
|
output_file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Output File Id
|
|
request_counts:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/BatchRequestCounts'
|
|
- type: 'null'
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/BatchUsage'
|
|
- type: 'null'
|
|
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'
|
|
title: Code
|
|
line:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Line
|
|
message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Message
|
|
param:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Param
|
|
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
|
|
Body_openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post:
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
description: The ID of the file to attach to the vector store.
|
|
attributes:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Attributes
|
|
description: The key-value attributes stored with the file, which can be used for filtering.
|
|
chunking_strategy:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
- type: 'null'
|
|
title: Chunking Strategy
|
|
description: The chunking strategy to use for the file.
|
|
type: object
|
|
required:
|
|
- file_id
|
|
title: Body_openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post
|
|
Body_openai_search_vector_store_v1_vector_stores__vector_store_id__search_post:
|
|
properties:
|
|
query:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: Query
|
|
description: The query string or array for performing the search.
|
|
filters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Filters
|
|
description: Filters based on file attributes to narrow the search results.
|
|
max_num_results:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 50.0
|
|
minimum: 1.0
|
|
- type: 'null'
|
|
title: Max Num Results
|
|
description: Maximum number of results to return (1 to 50 inclusive, default 10).
|
|
default: 10
|
|
ranking_options:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SearchRankingOptions'
|
|
- type: 'null'
|
|
description: Ranking options for fine-tuning the search results.
|
|
rewrite_query:
|
|
type: boolean
|
|
title: Rewrite Query
|
|
description: Whether to rewrite the natural language query for vector search (default false).
|
|
default: false
|
|
search_mode:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Search Mode
|
|
description: The search mode to use - 'keyword', 'vector', or 'hybrid' (default 'vector').
|
|
default: vector
|
|
type: object
|
|
required:
|
|
- query
|
|
title: Body_openai_search_vector_store_v1_vector_stores__vector_store_id__search_post
|
|
Body_openai_upload_file_v1_files_post:
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
title: File
|
|
description: The File object to be uploaded.
|
|
purpose:
|
|
$ref: '#/components/schemas/OpenAIFilePurpose'
|
|
description: The intended purpose of the uploaded file.
|
|
expires_after:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ExpiresAfter'
|
|
- type: 'null'
|
|
description: Optional form values describing expiration for the file.
|
|
type: object
|
|
required:
|
|
- file
|
|
- purpose
|
|
title: Body_openai_upload_file_v1_files_post
|
|
Body_rag_tool_insert_v1_tool_runtime_rag_tool_insert_post:
|
|
properties:
|
|
documents:
|
|
items:
|
|
$ref: '#/components/schemas/RAGDocument'
|
|
type: array
|
|
title: Documents
|
|
description: List of documents to index in the RAG system.
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
description: ID of the vector database to store the document embeddings.
|
|
chunk_size_in_tokens:
|
|
type: integer
|
|
title: Chunk Size In Tokens
|
|
description: Size in tokens for document chunking during indexing.
|
|
default: 512
|
|
type: object
|
|
required:
|
|
- documents
|
|
- vector_store_id
|
|
title: Body_rag_tool_insert_v1_tool_runtime_rag_tool_insert_post
|
|
Body_rag_tool_query_v1_tool_runtime_rag_tool_query_post:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
title: Content
|
|
description: The query content to search for in the indexed documents.
|
|
vector_store_ids:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Vector Store Ids
|
|
description: List of vector database IDs to search within.
|
|
query_config:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/RAGQueryConfig'
|
|
- type: 'null'
|
|
description: Configuration parameters for the query operation.
|
|
type: object
|
|
required:
|
|
- content
|
|
- vector_store_ids
|
|
title: Body_rag_tool_query_v1_tool_runtime_rag_tool_query_post
|
|
BooleanType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: boolean
|
|
title: Type
|
|
default: boolean
|
|
type: object
|
|
title: BooleanType
|
|
description: "Parameter type for boolean values.\n\n:param type: Discriminator type. Always \"boolean\""
|
|
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.\n\n:param type: Discriminator type. Always \"chat_completion_input\""
|
|
Chunk-Input:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
title: Content
|
|
chunk_id:
|
|
type: string
|
|
title: Chunk Id
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
title: Embedding
|
|
chunk_metadata:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ChunkMetadata'
|
|
- type: 'null'
|
|
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'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
title: Content
|
|
chunk_id:
|
|
type: string
|
|
title: Chunk Id
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
embedding:
|
|
anyOf:
|
|
- items:
|
|
type: number
|
|
type: array
|
|
- type: 'null'
|
|
title: Embedding
|
|
chunk_metadata:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ChunkMetadata'
|
|
- type: 'null'
|
|
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'
|
|
title: Chunk Id
|
|
document_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Document Id
|
|
source:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Source
|
|
created_timestamp:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Created Timestamp
|
|
updated_timestamp:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Updated Timestamp
|
|
chunk_window:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Chunk Window
|
|
chunk_tokenizer:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Chunk Tokenizer
|
|
chunk_embedding_model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Chunk Embedding Model
|
|
chunk_embedding_dimension:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Chunk Embedding Dimension
|
|
content_token_count:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Content Token Count
|
|
metadata_token_count:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Metadata Token Count
|
|
type: object
|
|
title: ChunkMetadata
|
|
description: "`ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that\n will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata`\n is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after.\n 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.\n\n:param type: Discriminator type. Always \"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'
|
|
title: Metadata
|
|
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'
|
|
title: Items
|
|
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.
|
|
ConversationCreateRequest:
|
|
properties:
|
|
items:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
type: array
|
|
maxItems: 20
|
|
- type: 'null'
|
|
title: Items
|
|
description: Initial items to include in the conversation context. You may add up to 20 items at a time.
|
|
default: []
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
maxProperties: 16
|
|
- type: 'null'
|
|
title: Metadata
|
|
description: Set of 16 key-value pairs that can be attached to an object. Useful for storing additional information
|
|
default: {}
|
|
type: object
|
|
title: ConversationCreateRequest
|
|
description: Request body for creating a conversation.
|
|
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.
|
|
ConversationItemCreateRequest:
|
|
properties:
|
|
items:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
type: array
|
|
maxItems: 20
|
|
title: Items
|
|
description: Items to include in the conversation context. You may add up to 20 items at a time.
|
|
type: object
|
|
required:
|
|
- items
|
|
title: ConversationItemCreateRequest
|
|
description: Request body for creating conversation items.
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
type: array
|
|
title: Data
|
|
description: List of conversation items
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: First Id
|
|
description: The ID of the first item in the list
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Last Id
|
|
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.
|
|
ConversationUpdateRequest:
|
|
properties:
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
title: Metadata
|
|
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. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
|
|
type: object
|
|
required:
|
|
- metadata
|
|
title: ConversationUpdateRequest
|
|
description: Request body for updating a conversation.
|
|
CreateBatchRequest:
|
|
properties:
|
|
input_file_id:
|
|
type: string
|
|
title: Input File Id
|
|
description: The ID of an uploaded file containing requests for the batch.
|
|
endpoint:
|
|
type: string
|
|
title: Endpoint
|
|
description: The endpoint to be used for all requests in the batch.
|
|
completion_window:
|
|
type: string
|
|
const: 24h
|
|
title: Completion Window
|
|
description: The time window within which the batch should be processed.
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
description: Optional metadata for the batch.
|
|
idempotency_key:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Idempotency Key
|
|
description: Optional idempotency key. When provided, enables idempotent behavior.
|
|
type: object
|
|
required:
|
|
- input_file_id
|
|
- endpoint
|
|
- completion_window
|
|
title: CreateBatchRequest
|
|
description: Request model for creating a batch.
|
|
CreateOpenAIResponseRequest:
|
|
properties:
|
|
input:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
|
|
type: array
|
|
title: Input
|
|
description: Input message(s) to create the response
|
|
model:
|
|
type: string
|
|
title: Model
|
|
description: The underlying LLM used for completions
|
|
prompt:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponsePrompt'
|
|
- type: 'null'
|
|
description: Prompt object with ID, version, and variables
|
|
instructions:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Instructions
|
|
description: System instructions
|
|
previous_response_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Previous Response Id
|
|
description: If specified, the new response will be a continuation of the previous response
|
|
conversation:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Conversation
|
|
description: The ID of a conversation to add the response to. Must begin with 'conv_'
|
|
store:
|
|
type: boolean
|
|
title: Store
|
|
description: Whether to store the response
|
|
default: true
|
|
stream:
|
|
type: boolean
|
|
title: Stream
|
|
description: Whether to stream the response
|
|
default: false
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Temperature
|
|
description: Sampling temperature
|
|
text:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseText'
|
|
- type: 'null'
|
|
description: Text generation parameters
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
- $ref: '#/components/schemas/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_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
type: array
|
|
- type: 'null'
|
|
title: Tools
|
|
description: Tools to make available
|
|
include:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Include
|
|
description: Additional fields to include in the response
|
|
max_infer_iters:
|
|
type: integer
|
|
title: Max Infer Iters
|
|
description: Maximum number of inference iterations (extension to the OpenAI API)
|
|
default: 10
|
|
guardrails:
|
|
anyOf:
|
|
- items:
|
|
anyOf:
|
|
- type: string
|
|
- $ref: '#/components/schemas/ResponseGuardrailSpec'
|
|
type: array
|
|
- type: 'null'
|
|
title: Guardrails
|
|
description: List of guardrails to apply during response generation
|
|
type: object
|
|
required:
|
|
- input
|
|
- model
|
|
title: CreateOpenAIResponseRequest
|
|
description: Request to create a model response.
|
|
CreatePromptRequest:
|
|
properties:
|
|
prompt:
|
|
type: string
|
|
title: Prompt
|
|
description: The prompt text content with variable placeholders.
|
|
variables:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Variables
|
|
description: List of variable names that can be used in the prompt template.
|
|
type: object
|
|
required:
|
|
- prompt
|
|
title: CreatePromptRequest
|
|
description: Request model for creating a new prompt.
|
|
DefaultRAGQueryGeneratorConfig:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: default
|
|
title: Type
|
|
default: default
|
|
separator:
|
|
type: string
|
|
title: Separator
|
|
default: ' '
|
|
type: object
|
|
title: DefaultRAGQueryGeneratorConfig
|
|
description: "Configuration for the default RAG query generator.\n\n:param type: Type of query generator, always 'default'\n:param separator: String separator used to join query terms"
|
|
Error:
|
|
properties:
|
|
status:
|
|
type: integer
|
|
title: Status
|
|
description: HTTP status code
|
|
title:
|
|
type: string
|
|
title: Title
|
|
description: Error title, a short summary of the error which is invariant for an error type
|
|
detail:
|
|
type: string
|
|
title: Detail
|
|
description: Error detail, a longer human-readable description of the error
|
|
instance:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Instance
|
|
description: (Optional) A URL which can be used to retrieve more information about the specific occurrence of the error
|
|
type: object
|
|
required:
|
|
- status
|
|
- title
|
|
- detail
|
|
title: Error
|
|
description: Error response from the API. Roughly follows RFC 7807.
|
|
Errors:
|
|
properties:
|
|
data:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/BatchError'
|
|
type: array
|
|
- type: 'null'
|
|
title: Data
|
|
object:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Object
|
|
additionalProperties: true
|
|
type: object
|
|
title: Errors
|
|
ExpiresAfter:
|
|
properties:
|
|
anchor:
|
|
type: string
|
|
const: created_at
|
|
title: Anchor
|
|
description: Anchor must be 'created_at'.
|
|
seconds:
|
|
type: integer
|
|
maximum: 2592000.0
|
|
minimum: 3600.0
|
|
title: Seconds
|
|
description: Seconds between 3600 and 2592000 (1 hour to 30 days).
|
|
type: object
|
|
required:
|
|
- anchor
|
|
- seconds
|
|
title: ExpiresAfter
|
|
description: Control expiration of uploaded files.
|
|
HealthInfo:
|
|
properties:
|
|
status:
|
|
$ref: '#/components/schemas/HealthStatus'
|
|
description: Current health status of the service
|
|
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
|
|
InsertChunksRequest:
|
|
properties:
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
description: The identifier of the vector database to insert the chunks into.
|
|
chunks:
|
|
items:
|
|
$ref: '#/components/schemas/Chunk-Input'
|
|
type: array
|
|
title: Chunks
|
|
description: The chunks to insert.
|
|
ttl_seconds:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Ttl Seconds
|
|
description: The time to live of the chunks.
|
|
type: object
|
|
required:
|
|
- vector_store_id
|
|
- chunks
|
|
title: InsertChunksRequest
|
|
description: Request to insert chunks into a vector database.
|
|
InvokeToolRequest:
|
|
properties:
|
|
tool_name:
|
|
type: string
|
|
title: Tool Name
|
|
description: The name of the tool to invoke
|
|
kwargs:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Kwargs
|
|
description: A dictionary of arguments to pass to the tool
|
|
type: object
|
|
required:
|
|
- tool_name
|
|
- kwargs
|
|
title: InvokeToolRequest
|
|
description: Request model for invoking a tool.
|
|
JsonType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: json
|
|
title: Type
|
|
default: json
|
|
type: object
|
|
title: JsonType
|
|
description: "Parameter type for JSON values.\n\n:param type: Discriminator type. Always \"json\""
|
|
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'
|
|
title: Prompt Template
|
|
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.
|
|
LLMRAGQueryGeneratorConfig:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: llm
|
|
title: Type
|
|
default: llm
|
|
model:
|
|
type: string
|
|
title: Model
|
|
template:
|
|
type: string
|
|
title: Template
|
|
type: object
|
|
required:
|
|
- model
|
|
- template
|
|
title: LLMRAGQueryGeneratorConfig
|
|
description: "Configuration for the LLM-based RAG query generator.\n\n:param type: Type of query generator, always 'llm'\n:param model: Name of the language model to use for query generation\n:param template: Template string for formatting the query generation prompt"
|
|
ListBatchesResponse:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
description: The object type, which is always 'list'.
|
|
default: list
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Batch'
|
|
type: array
|
|
title: Data
|
|
description: List of batch objects.
|
|
first_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: First Id
|
|
description: ID of the first batch in the list.
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Last Id
|
|
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.
|
|
ListModelsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Model'
|
|
type: array
|
|
title: Data
|
|
description: List of model resources.
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListModelsResponse
|
|
description: Response model for listing models.
|
|
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
|
|
description: List of file objects.
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
description: Whether there are more files available beyond this page.
|
|
first_id:
|
|
type: string
|
|
title: First Id
|
|
description: ID of the first file in the list for pagination.
|
|
last_id:
|
|
type: string
|
|
title: Last Id
|
|
description: ID of the last file in the list for pagination.
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
description: The object type, which is always 'list'.
|
|
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:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
type: array
|
|
title: Data
|
|
description: List of input items
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
description: Object type identifier, always "list"
|
|
default: list
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListOpenAIResponseInputItem
|
|
description: "List container for OpenAI response input items.\n\n:param data: List of input items\n:param object: Object type identifier, always \"list\""
|
|
ListOpenAIResponseObject:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/OpenAIResponseObjectWithInput-Output'
|
|
type: array
|
|
title: Data
|
|
description: List of response objects with their input context
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
description: Whether there are more results available beyond this page
|
|
first_id:
|
|
type: string
|
|
title: First Id
|
|
description: Identifier of the first item in this page
|
|
last_id:
|
|
type: string
|
|
title: Last Id
|
|
description: Identifier of the last item in this page
|
|
object:
|
|
type: string
|
|
const: list
|
|
title: Object
|
|
description: Object type identifier, always "list"
|
|
default: list
|
|
type: object
|
|
required:
|
|
- data
|
|
- has_more
|
|
- first_id
|
|
- last_id
|
|
title: ListOpenAIResponseObject
|
|
description: "Paginated list of OpenAI response objects with navigation metadata.\n\n:param data: List of response objects with their input context\n:param has_more: Whether there are more results available beyond this page\n:param first_id: Identifier of the first item in this page\n:param last_id: Identifier of the last item in this page\n:param object: Object type identifier, always \"list\""
|
|
ListPromptsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Prompt'
|
|
type: array
|
|
title: Data
|
|
description: List of prompt resources.
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListPromptsResponse
|
|
description: Response model to list prompts.
|
|
ListProvidersResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/ProviderInfo'
|
|
type: array
|
|
title: Data
|
|
description: List of provider information objects
|
|
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
|
|
description: List of available route information objects
|
|
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
|
|
description: List of scoring function resources
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListScoringFunctionsResponse
|
|
description: Response model for listing scoring functions.
|
|
ListShieldsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/Shield'
|
|
type: array
|
|
title: Data
|
|
description: List of shield resources
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListShieldsResponse
|
|
description: Response model for listing shields.
|
|
ListToolDefsResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/ToolDef'
|
|
type: array
|
|
title: Data
|
|
description: List of tool definitions
|
|
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
|
|
description: List of tool groups
|
|
type: object
|
|
required:
|
|
- data
|
|
title: ListToolGroupsResponse
|
|
description: Response containing a list of tool groups.
|
|
MCPListToolsTool:
|
|
properties:
|
|
input_schema:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Input Schema
|
|
description: JSON schema defining the tool's input parameters
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description: Name of the tool
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Description
|
|
description: Description of what the tool does
|
|
type: object
|
|
required:
|
|
- input_schema
|
|
- name
|
|
title: MCPListToolsTool
|
|
description: "Tool definition returned by MCP list tools operation.\n\n:param input_schema: JSON schema defining the tool's input parameters\n:param name: Name of the tool\n:param description: (Optional) Description of what the tool does"
|
|
Model:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Resource Id
|
|
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
|
|
description: The resource type, always 'model' for model resources.
|
|
default: model
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Any additional metadata for this model.
|
|
model_type:
|
|
$ref: '#/components/schemas/ModelType'
|
|
description: The type of model (LLM or embedding model).
|
|
default: llm
|
|
type: object
|
|
required:
|
|
- identifier
|
|
- provider_id
|
|
title: Model
|
|
description: A model resource representing an AI model registered in Llama Stack.
|
|
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
|
|
description: The unique identifier for the moderation request.
|
|
model:
|
|
type: string
|
|
title: Model
|
|
description: The model used to generate the moderation results.
|
|
results:
|
|
items:
|
|
$ref: '#/components/schemas/ModerationObjectResults'
|
|
type: array
|
|
title: Results
|
|
description: A list of moderation objects.
|
|
type: object
|
|
required:
|
|
- id
|
|
- model
|
|
- results
|
|
title: ModerationObject
|
|
description: A moderation object.
|
|
ModerationObjectResults:
|
|
properties:
|
|
flagged:
|
|
type: boolean
|
|
title: Flagged
|
|
description: Whether any of the below categories are flagged.
|
|
categories:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: boolean
|
|
type: object
|
|
- type: 'null'
|
|
title: Categories
|
|
description: A list of the categories, and whether they are flagged or not.
|
|
category_applied_input_types:
|
|
anyOf:
|
|
- additionalProperties:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
- type: 'null'
|
|
title: Category Applied Input Types
|
|
description: A list of the categories along with the input type(s) that the score applies to.
|
|
category_scores:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: number
|
|
type: object
|
|
- type: 'null'
|
|
title: Category Scores
|
|
description: A list of the categories along with their scores as predicted by model.
|
|
user_message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: User Message
|
|
description: User message.
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Additional 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.\n\n:param type: Discriminator type. Always \"number\""
|
|
ObjectType:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: object
|
|
title: Type
|
|
default: object
|
|
type: object
|
|
title: ObjectType
|
|
description: "Parameter type for object values.\n\n:param type: Discriminator type. Always \"object\""
|
|
OpenAIAssistantMessageParam-Input:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: assistant
|
|
title: Role
|
|
default: assistant
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
- type: 'null'
|
|
title: Content
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
tool_calls:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
|
|
type: array
|
|
- type: 'null'
|
|
title: Tool Calls
|
|
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
|
|
- type: 'null'
|
|
title: Content
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
tool_calls:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
|
|
type: array
|
|
- type: 'null'
|
|
title: Tool Calls
|
|
type: object
|
|
title: OpenAIAssistantMessageParam
|
|
description: A message containing the model's (assistant) response in 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'
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input'
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
- $ref: '#/components/schemas/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'
|
|
type: array
|
|
minItems: 1
|
|
title: Messages
|
|
frequency_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Frequency Penalty
|
|
function_call:
|
|
anyOf:
|
|
- type: string
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Function Call
|
|
functions:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
title: Functions
|
|
logit_bias:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: number
|
|
type: object
|
|
- type: 'null'
|
|
title: Logit Bias
|
|
logprobs:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Logprobs
|
|
max_completion_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Max Completion Tokens
|
|
max_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Max Tokens
|
|
n:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: N
|
|
parallel_tool_calls:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Parallel Tool Calls
|
|
presence_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Presence Penalty
|
|
response_format:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatText'
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema'
|
|
- $ref: '#/components/schemas/OpenAIResponseFormatJSONObject'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
json_object: '#/components/schemas/OpenAIResponseFormatJSONObject'
|
|
json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema'
|
|
text: '#/components/schemas/OpenAIResponseFormatText'
|
|
- type: 'null'
|
|
title: Response Format
|
|
seed:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Seed
|
|
stop:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Stop
|
|
stream:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Stream
|
|
stream_options:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Stream Options
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Temperature
|
|
tool_choice:
|
|
anyOf:
|
|
- type: string
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Tool Choice
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
- type: 'null'
|
|
title: Tools
|
|
top_logprobs:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Top Logprobs
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Top P
|
|
user:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: User
|
|
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'
|
|
title: Index
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Id
|
|
type:
|
|
type: string
|
|
const: function
|
|
title: Type
|
|
default: function
|
|
function:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction'
|
|
- type: 'null'
|
|
type: object
|
|
title: OpenAIChatCompletionToolCall
|
|
description: Tool call specification for OpenAI-compatible chat completion responses.
|
|
OpenAIChatCompletionToolCallFunction:
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
arguments:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Arguments
|
|
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'
|
|
- type: 'null'
|
|
completion_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails'
|
|
- type: 'null'
|
|
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'
|
|
title: Reasoning Tokens
|
|
type: object
|
|
title: OpenAIChatCompletionUsageCompletionTokensDetails
|
|
description: Token details for output tokens in OpenAI chat completion usage.
|
|
OpenAIChatCompletionUsagePromptTokensDetails:
|
|
properties:
|
|
cached_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Cached Tokens
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output'
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
|
|
title: Message
|
|
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'
|
|
- type: 'null'
|
|
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'
|
|
title: Content
|
|
refusal:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAITokenLogProb'
|
|
type: array
|
|
- type: 'null'
|
|
title: Refusal
|
|
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.\n\n:id: The ID of the completion\n:choices: List of choices\n:created: The Unix timestamp in seconds when the completion was created\n:model: The model that was used to generate the completion\n: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'
|
|
- type: 'null'
|
|
type: object
|
|
required:
|
|
- finish_reason
|
|
- text
|
|
- index
|
|
title: OpenAICompletionChoice
|
|
description: "A choice from an OpenAI-compatible completion response.\n\n:finish_reason: The reason the model stopped generating\n:text: The text of the choice\n:index: The index of the choice\n: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
|
|
- items:
|
|
type: integer
|
|
type: array
|
|
- items:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
type: array
|
|
title: Prompt
|
|
best_of:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Best Of
|
|
echo:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Echo
|
|
frequency_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Frequency Penalty
|
|
logit_bias:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: number
|
|
type: object
|
|
- type: 'null'
|
|
title: Logit Bias
|
|
logprobs:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 5.0
|
|
minimum: 0.0
|
|
- type: 'null'
|
|
title: Logprobs
|
|
max_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Max Tokens
|
|
n:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: N
|
|
presence_penalty:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Presence Penalty
|
|
seed:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Seed
|
|
stop:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Stop
|
|
stream:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Stream
|
|
stream_options:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Stream Options
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Temperature
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Top P
|
|
user:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: User
|
|
suffix:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Suffix
|
|
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'
|
|
- type: 'null'
|
|
input_messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam-Output'
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output'
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
- $ref: '#/components/schemas/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'
|
|
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'
|
|
title: Attributes
|
|
chunking_strategy:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
|
|
static: '#/components/schemas/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'
|
|
title: Name
|
|
file_ids:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: File Ids
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Expires After
|
|
chunking_strategy:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Chunking Strategy
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
additionalProperties: true
|
|
type: object
|
|
title: OpenAICreateVectorStoreRequestWithExtraBody
|
|
description: Request to create a vector store with extra_body support.
|
|
OpenAIDeleteResponseObject:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier of the deleted response
|
|
object:
|
|
type: string
|
|
const: response
|
|
title: Object
|
|
description: Object type identifier, always "response"
|
|
default: response
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
description: Deletion confirmation flag, always True
|
|
default: true
|
|
type: object
|
|
required:
|
|
- id
|
|
title: OpenAIDeleteResponseObject
|
|
description: "Response object confirming deletion of an OpenAI response.\n\n:param id: Unique identifier of the deleted response\n:param object: Object type identifier, always \"response\"\n:param deleted: Deletion confirmation flag, always True"
|
|
OpenAIDeveloperMessageParam:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: developer
|
|
title: Role
|
|
default: developer
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: Content
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
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
|
|
- type: string
|
|
title: Embedding
|
|
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: Input
|
|
encoding_format:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Encoding Format
|
|
default: float
|
|
dimensions:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Dimensions
|
|
user:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: User
|
|
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
|
|
description: The file identifier that was deleted.
|
|
object:
|
|
type: string
|
|
const: file
|
|
title: Object
|
|
description: The object type, which is always 'file'.
|
|
default: file
|
|
deleted:
|
|
type: boolean
|
|
title: Deleted
|
|
description: Whether the file was successfully deleted.
|
|
type: object
|
|
required:
|
|
- id
|
|
- deleted
|
|
title: OpenAIFileDeleteResponse
|
|
description: Response for deleting a file in OpenAI Files API.
|
|
OpenAIFileFile:
|
|
properties:
|
|
file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: File Id
|
|
filename:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Filename
|
|
type: object
|
|
title: OpenAIFileFile
|
|
OpenAIFileObject:
|
|
properties:
|
|
object:
|
|
type: string
|
|
const: file
|
|
title: Object
|
|
description: The object type, which is always 'file'.
|
|
default: file
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: The file identifier, which can be referenced in the API endpoints.
|
|
bytes:
|
|
type: integer
|
|
title: Bytes
|
|
description: The size of the file, in bytes.
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
description: The Unix timestamp (in seconds) for when the file was created.
|
|
expires_at:
|
|
type: integer
|
|
title: Expires At
|
|
description: The Unix timestamp (in seconds) for when the file expires.
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
description: The name of the file.
|
|
purpose:
|
|
$ref: '#/components/schemas/OpenAIFilePurpose'
|
|
description: The intended purpose of the file.
|
|
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'
|
|
title: Detail
|
|
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'
|
|
title: Description
|
|
strict:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Strict
|
|
schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Schema
|
|
type: object
|
|
title: OpenAIJSONSchema
|
|
description: JSON schema specification for OpenAI-compatible structured response format.
|
|
OpenAIResponseAnnotationCitation:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: url_citation
|
|
title: Type
|
|
description: Annotation type identifier, always "url_citation"
|
|
default: url_citation
|
|
end_index:
|
|
type: integer
|
|
title: End Index
|
|
description: End position of the citation span in the content
|
|
start_index:
|
|
type: integer
|
|
title: Start Index
|
|
description: Start position of the citation span in the content
|
|
title:
|
|
type: string
|
|
title: Title
|
|
description: Title of the referenced web resource
|
|
url:
|
|
type: string
|
|
title: Url
|
|
description: URL of the referenced web resource
|
|
type: object
|
|
required:
|
|
- end_index
|
|
- start_index
|
|
- title
|
|
- url
|
|
title: OpenAIResponseAnnotationCitation
|
|
description: "URL citation annotation for referencing external web resources.\n\n:param type: Annotation type identifier, always \"url_citation\"\n:param end_index: End position of the citation span in the content\n:param start_index: Start position of the citation span in the content\n:param title: Title of the referenced web resource\n:param url: URL of the referenced web resource"
|
|
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
|
|
description: Annotation type identifier, always "file_citation"
|
|
default: file_citation
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
description: Unique identifier of the referenced file
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
description: Name of the referenced file
|
|
index:
|
|
type: integer
|
|
title: Index
|
|
description: Position index of the citation within the content
|
|
type: object
|
|
required:
|
|
- file_id
|
|
- filename
|
|
- index
|
|
title: OpenAIResponseAnnotationFileCitation
|
|
description: "File citation annotation for referencing specific files in response content.\n\n:param type: Annotation type identifier, always \"file_citation\"\n:param file_id: Unique identifier of the referenced file\n:param filename: Name of the referenced file\n:param index: Position index of the citation within the 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
|
|
description: Content part type identifier, always "refusal"
|
|
default: refusal
|
|
refusal:
|
|
type: string
|
|
title: Refusal
|
|
description: Refusal text supplied by the model
|
|
type: object
|
|
required:
|
|
- refusal
|
|
title: OpenAIResponseContentPartRefusal
|
|
description: "Refusal content within a streamed response part.\n\n:param type: Content part type identifier, always \"refusal\"\n:param refusal: Refusal text supplied by the model"
|
|
OpenAIResponseError:
|
|
properties:
|
|
code:
|
|
type: string
|
|
title: Code
|
|
description: Error code identifying the type of failure
|
|
message:
|
|
type: string
|
|
title: Message
|
|
description: Human-readable error message describing the failure
|
|
type: object
|
|
required:
|
|
- code
|
|
- message
|
|
title: OpenAIResponseError
|
|
description: "Error details for failed OpenAI response requests.\n\n:param code: Error code identifying the type of failure\n:param message: Human-readable error message describing the failure"
|
|
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'
|
|
title: Id
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Status
|
|
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
|
|
description: The type of the input item. Always `input_file`.
|
|
default: input_file
|
|
file_data:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: File Data
|
|
description: The data of the file to be sent to the model.
|
|
file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: File Id
|
|
description: The ID of the file to be sent to the model.
|
|
file_url:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: File Url
|
|
description: The URL of the file to be sent to the model.
|
|
filename:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Filename
|
|
description: The name of the file to be sent to the model.
|
|
type: object
|
|
title: OpenAIResponseInputMessageContentFile
|
|
description: "File content for input messages in OpenAI response format.\n\n:param type: The type of the input item. Always `input_file`.\n:param file_data: The data of the file to be sent to the model.\n:param file_id: (Optional) The ID of the file to be sent to the model.\n:param file_url: The URL of the file to be sent to the model.\n:param filename: The name of the file to be sent to the model."
|
|
OpenAIResponseInputMessageContentImage:
|
|
properties:
|
|
detail:
|
|
anyOf:
|
|
- type: string
|
|
const: low
|
|
- type: string
|
|
const: high
|
|
- type: string
|
|
const: auto
|
|
title: Detail
|
|
description: Level of detail for image processing, can be "low", "high", or "auto"
|
|
default: auto
|
|
type:
|
|
type: string
|
|
const: input_image
|
|
title: Type
|
|
description: Content type identifier, always "input_image"
|
|
default: input_image
|
|
file_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: File Id
|
|
description: The ID of the file to be sent to the model.
|
|
image_url:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Image Url
|
|
description: URL of the image content
|
|
type: object
|
|
title: OpenAIResponseInputMessageContentImage
|
|
description: "Image content for input messages in OpenAI response format.\n\n:param detail: Level of detail for image processing, can be \"low\", \"high\", or \"auto\"\n:param type: Content type identifier, always \"input_image\"\n:param file_id: (Optional) The ID of the file to be sent to the model.\n:param image_url: (Optional) URL of the image content"
|
|
OpenAIResponseInputMessageContentText:
|
|
properties:
|
|
text:
|
|
type: string
|
|
title: Text
|
|
description: The text content of the input message
|
|
type:
|
|
type: string
|
|
const: input_text
|
|
title: Type
|
|
description: Content type identifier, always "input_text"
|
|
default: input_text
|
|
type: object
|
|
required:
|
|
- text
|
|
title: OpenAIResponseInputMessageContentText
|
|
description: "Text content for input messages in OpenAI response format.\n\n:param text: The text content of the input message\n:param type: Content type identifier, always \"input_text\""
|
|
OpenAIResponseInputToolFileSearch:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: file_search
|
|
title: Type
|
|
description: Tool type identifier, always "file_search"
|
|
default: file_search
|
|
vector_store_ids:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Vector Store Ids
|
|
description: List of vector store identifiers to search within
|
|
filters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Filters
|
|
description: Additional filters to apply to the search
|
|
max_num_results:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 50.0
|
|
minimum: 1.0
|
|
- type: 'null'
|
|
title: Max Num Results
|
|
description: Maximum number of search results to return (1-50)
|
|
default: 10
|
|
ranking_options:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SearchRankingOptions'
|
|
- type: 'null'
|
|
description: Options for ranking and scoring search results
|
|
type: object
|
|
required:
|
|
- vector_store_ids
|
|
title: OpenAIResponseInputToolFileSearch
|
|
description: "File search tool configuration for OpenAI response inputs.\n\n:param type: Tool type identifier, always \"file_search\"\n:param vector_store_ids: List of vector store identifiers to search within\n:param filters: (Optional) Additional filters to apply to the search\n:param max_num_results: (Optional) Maximum number of search results to return (1-50)\n:param ranking_options: (Optional) Options for ranking and scoring search results"
|
|
OpenAIResponseInputToolFunction:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: function
|
|
title: Type
|
|
description: Tool type identifier, always "function"
|
|
default: function
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description: Name of the function that can be called
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Description
|
|
description: Description of what the function does
|
|
parameters:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Parameters
|
|
description: JSON schema defining the function's parameters
|
|
strict:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Strict
|
|
description: Whether to enforce strict parameter validation
|
|
type: object
|
|
required:
|
|
- name
|
|
title: OpenAIResponseInputToolFunction
|
|
description: "Function tool configuration for OpenAI response inputs.\n\n:param type: Tool type identifier, always \"function\"\n:param name: Name of the function that can be called\n:param description: (Optional) Description of what the function does\n:param parameters: (Optional) JSON schema defining the function's parameters\n:param strict: (Optional) Whether to enforce strict parameter validation"
|
|
OpenAIResponseInputToolMCP:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: mcp
|
|
title: Type
|
|
description: Tool type identifier, always "mcp"
|
|
default: mcp
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
description: Label to identify this MCP server
|
|
server_url:
|
|
type: string
|
|
title: Server Url
|
|
description: URL endpoint of the MCP server
|
|
headers:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Headers
|
|
description: HTTP headers to include when connecting to the server
|
|
require_approval:
|
|
anyOf:
|
|
- type: string
|
|
const: always
|
|
- type: string
|
|
const: never
|
|
- $ref: '#/components/schemas/ApprovalFilter'
|
|
title: Require Approval
|
|
description: Approval requirement for tool calls ("always", "never", or filter)
|
|
default: never
|
|
allowed_tools:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- $ref: '#/components/schemas/AllowedToolsFilter'
|
|
- type: 'null'
|
|
title: Allowed Tools
|
|
description: Restriction on which tools can be used from this server
|
|
type: object
|
|
required:
|
|
- server_label
|
|
- server_url
|
|
title: OpenAIResponseInputToolMCP
|
|
description: "Model Context Protocol (MCP) tool configuration for OpenAI response inputs.\n\n:param type: Tool type identifier, always \"mcp\"\n:param server_label: Label to identify this MCP server\n:param server_url: URL endpoint of the MCP server\n:param headers: (Optional) HTTP headers to include when connecting to the server\n:param require_approval: Approval requirement for tool calls (\"always\", \"never\", or filter)\n:param allowed_tools: (Optional) Restriction on which tools can be used from this server"
|
|
OpenAIResponseInputToolWebSearch:
|
|
properties:
|
|
type:
|
|
anyOf:
|
|
- type: string
|
|
const: web_search
|
|
- type: string
|
|
const: web_search_preview
|
|
- type: string
|
|
const: web_search_preview_2025_03_11
|
|
title: Type
|
|
description: Web search tool type variant to use
|
|
default: web_search
|
|
search_context_size:
|
|
anyOf:
|
|
- type: string
|
|
pattern: ^low|medium|high$
|
|
- type: 'null'
|
|
title: Search Context Size
|
|
description: Size of search context, must be "low", "medium", or "high"
|
|
default: medium
|
|
type: object
|
|
title: OpenAIResponseInputToolWebSearch
|
|
description: "Web search tool configuration for OpenAI response inputs.\n\n:param type: Web search tool type variant to use\n:param search_context_size: (Optional) Size of search context, must be \"low\", \"medium\", or \"high\""
|
|
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'
|
|
title: Id
|
|
reason:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Reason
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
type: array
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
type: array
|
|
title: Content
|
|
role:
|
|
anyOf:
|
|
- type: string
|
|
const: system
|
|
- type: string
|
|
const: developer
|
|
- type: string
|
|
const: user
|
|
- type: string
|
|
const: assistant
|
|
title: Role
|
|
type:
|
|
type: string
|
|
const: message
|
|
title: Type
|
|
default: message
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Id
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Status
|
|
type: object
|
|
required:
|
|
- content
|
|
- role
|
|
title: OpenAIResponseMessage
|
|
description: "Corresponds to the various Message types in the Responses API.\nThey are all under one type because the Responses API gives them all\nthe same \"type\" value, and there is no way to tell them apart in certain\nscenarios."
|
|
OpenAIResponseMessage-Output:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
type: array
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
|
|
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
|
type: array
|
|
title: Content
|
|
role:
|
|
anyOf:
|
|
- type: string
|
|
const: system
|
|
- type: string
|
|
const: developer
|
|
- type: string
|
|
const: user
|
|
- type: string
|
|
const: assistant
|
|
title: Role
|
|
type:
|
|
type: string
|
|
const: message
|
|
title: Type
|
|
default: message
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Id
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Status
|
|
type: object
|
|
required:
|
|
- content
|
|
- role
|
|
title: OpenAIResponseMessage
|
|
description: "Corresponds to the various Message types in the Responses API.\nThey are all under one type because the Responses API gives them all\nthe same \"type\" value, and there is no way to tell them apart in certain\nscenarios."
|
|
OpenAIResponseObject:
|
|
properties:
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
description: Unix timestamp when the response was created
|
|
error:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseError'
|
|
- type: 'null'
|
|
description: Error details if the response generation failed
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier for this response
|
|
model:
|
|
type: string
|
|
title: Model
|
|
description: Model identifier used for generation
|
|
object:
|
|
type: string
|
|
const: response
|
|
title: Object
|
|
description: Object type identifier, always "response"
|
|
default: response
|
|
output:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
type: array
|
|
title: Output
|
|
description: List of generated output items (messages, tool calls, etc.)
|
|
parallel_tool_calls:
|
|
type: boolean
|
|
title: Parallel Tool Calls
|
|
description: Whether tool calls can be executed in parallel
|
|
default: false
|
|
previous_response_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Previous Response Id
|
|
description: ID of the previous response in a conversation
|
|
prompt:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponsePrompt'
|
|
- type: 'null'
|
|
description: Reference to a prompt template and its variables.
|
|
status:
|
|
type: string
|
|
title: Status
|
|
description: Current status of the response generation
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Temperature
|
|
description: Sampling temperature used for generation
|
|
text:
|
|
$ref: '#/components/schemas/OpenAIResponseText'
|
|
description: Text formatting configuration for the response
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Top P
|
|
description: Nucleus sampling parameter used for generation
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
- $ref: '#/components/schemas/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_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
type: array
|
|
- type: 'null'
|
|
title: Tools
|
|
description: An array of tools the model may call while generating a response.
|
|
truncation:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Truncation
|
|
description: Truncation strategy applied to the response
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsage'
|
|
- type: 'null'
|
|
description: Token usage information for the response
|
|
instructions:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Instructions
|
|
description: System message inserted into the model's context
|
|
type: object
|
|
required:
|
|
- created_at
|
|
- id
|
|
- model
|
|
- output
|
|
- status
|
|
title: OpenAIResponseObject
|
|
description: "Complete OpenAI response object containing generation results and metadata.\n\n:param created_at: Unix timestamp when the response was created\n:param error: (Optional) Error details if the response generation failed\n:param id: Unique identifier for this response\n:param model: Model identifier used for generation\n:param object: Object type identifier, always \"response\"\n:param output: List of generated output items (messages, tool calls, etc.)\n:param parallel_tool_calls: Whether tool calls can be executed in parallel\n:param previous_response_id: (Optional) ID of the previous response in a conversation\n:param prompt: (Optional) Reference to a prompt template and its variables.\n:param status: Current status of the response generation\n:param temperature: (Optional) Sampling temperature used for generation\n:param text: Text formatting configuration for the response\n:param top_p: (Optional) Nucleus sampling parameter used for generation\n:param tools: (Optional) An array of tools the model may call while generating a response.\n:param truncation: (Optional) Truncation strategy applied to the response\n:param usage: (Optional) Token usage information for the response\n:param instructions: (Optional) System message inserted into the model's context"
|
|
OpenAIResponseObjectWithInput-Output:
|
|
properties:
|
|
created_at:
|
|
type: integer
|
|
title: Created At
|
|
description: Unix timestamp when the response was created
|
|
error:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseError'
|
|
- type: 'null'
|
|
description: Error details if the response generation failed
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier for this response
|
|
model:
|
|
type: string
|
|
title: Model
|
|
description: Model identifier used for generation
|
|
object:
|
|
type: string
|
|
const: response
|
|
title: Object
|
|
description: Object type identifier, always "response"
|
|
default: response
|
|
output:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
type: array
|
|
title: Output
|
|
description: List of generated output items (messages, tool calls, etc.)
|
|
parallel_tool_calls:
|
|
type: boolean
|
|
title: Parallel Tool Calls
|
|
description: Whether tool calls can be executed in parallel
|
|
default: false
|
|
previous_response_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Previous Response Id
|
|
description: ID of the previous response in a conversation
|
|
prompt:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponsePrompt'
|
|
- type: 'null'
|
|
description: Reference to a prompt template and its variables.
|
|
status:
|
|
type: string
|
|
title: Status
|
|
description: Current status of the response generation
|
|
temperature:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Temperature
|
|
description: Sampling temperature used for generation
|
|
text:
|
|
$ref: '#/components/schemas/OpenAIResponseText'
|
|
description: Text formatting configuration for the response
|
|
top_p:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Top P
|
|
description: Nucleus sampling parameter used for generation
|
|
tools:
|
|
anyOf:
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
|
|
- $ref: '#/components/schemas/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_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
|
|
type: array
|
|
- type: 'null'
|
|
title: Tools
|
|
description: An array of tools the model may call while generating a response.
|
|
truncation:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Truncation
|
|
description: Truncation strategy applied to the response
|
|
usage:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsage'
|
|
- type: 'null'
|
|
description: Token usage information for the response
|
|
instructions:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Instructions
|
|
description: System message inserted into the model's context
|
|
input:
|
|
items:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
|
|
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
|
|
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
|
|
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
|
|
type: array
|
|
title: Input
|
|
description: List of input items that led to this response
|
|
type: object
|
|
required:
|
|
- created_at
|
|
- id
|
|
- model
|
|
- output
|
|
- status
|
|
- input
|
|
title: OpenAIResponseObjectWithInput
|
|
description: "OpenAI response object extended with input context information.\n\n:param input: List of input items that led to this response"
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
|
|
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
|
|
- $ref: '#/components/schemas/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'
|
|
type: array
|
|
title: Annotations
|
|
type: object
|
|
required:
|
|
- text
|
|
title: OpenAIResponseOutputMessageContentOutputText
|
|
OpenAIResponseOutputMessageFileSearchToolCall:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier for this tool call
|
|
queries:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Queries
|
|
description: List of search queries executed
|
|
status:
|
|
type: string
|
|
title: Status
|
|
description: Current status of the file search operation
|
|
type:
|
|
type: string
|
|
const: file_search_call
|
|
title: Type
|
|
description: Tool call type identifier, always "file_search_call"
|
|
default: file_search_call
|
|
results:
|
|
anyOf:
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults'
|
|
type: array
|
|
- type: 'null'
|
|
title: Results
|
|
description: Search results returned by the file search operation
|
|
type: object
|
|
required:
|
|
- id
|
|
- queries
|
|
- status
|
|
title: OpenAIResponseOutputMessageFileSearchToolCall
|
|
description: "File search tool call output message for OpenAI responses.\n\n:param id: Unique identifier for this tool call\n:param queries: List of search queries executed\n:param status: Current status of the file search operation\n:param type: Tool call type identifier, always \"file_search_call\"\n:param results: (Optional) Search results returned by the file search operation"
|
|
OpenAIResponseOutputMessageFileSearchToolCallResults:
|
|
properties:
|
|
attributes:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Attributes
|
|
description: Key-value attributes associated with the file
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
description: Unique identifier of the file containing the result
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
description: Name of the file containing the result
|
|
score:
|
|
type: number
|
|
title: Score
|
|
description: Relevance score for this search result (between 0 and 1)
|
|
text:
|
|
type: string
|
|
title: Text
|
|
description: Text content of the search result
|
|
type: object
|
|
required:
|
|
- attributes
|
|
- file_id
|
|
- filename
|
|
- score
|
|
- text
|
|
title: OpenAIResponseOutputMessageFileSearchToolCallResults
|
|
description: "Search results returned by the file search operation.\n\n:param attributes: (Optional) Key-value attributes associated with the file\n:param file_id: Unique identifier of the file containing the result\n:param filename: Name of the file containing the result\n:param score: Relevance score for this search result (between 0 and 1)\n:param text: Text content of the search result"
|
|
OpenAIResponseOutputMessageFunctionToolCall:
|
|
properties:
|
|
call_id:
|
|
type: string
|
|
title: Call Id
|
|
description: Unique identifier for the function call
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description: Name of the function being called
|
|
arguments:
|
|
type: string
|
|
title: Arguments
|
|
description: JSON string containing the function arguments
|
|
type:
|
|
type: string
|
|
const: function_call
|
|
title: Type
|
|
description: Tool call type identifier, always "function_call"
|
|
default: function_call
|
|
id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Id
|
|
description: Additional identifier for the tool call
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Status
|
|
description: Current status of the function call execution
|
|
type: object
|
|
required:
|
|
- call_id
|
|
- name
|
|
- arguments
|
|
title: OpenAIResponseOutputMessageFunctionToolCall
|
|
description: "Function tool call output message for OpenAI responses.\n\n:param call_id: Unique identifier for the function call\n:param name: Name of the function being called\n:param arguments: JSON string containing the function arguments\n:param type: Tool call type identifier, always \"function_call\"\n:param id: (Optional) Additional identifier for the tool call\n:param status: (Optional) Current status of the function call execution"
|
|
OpenAIResponseOutputMessageMCPCall:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier for this MCP call
|
|
type:
|
|
type: string
|
|
const: mcp_call
|
|
title: Type
|
|
description: Tool call type identifier, always "mcp_call"
|
|
default: mcp_call
|
|
arguments:
|
|
type: string
|
|
title: Arguments
|
|
description: JSON string containing the MCP call arguments
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description: Name of the MCP method being called
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
description: Label identifying the MCP server handling the call
|
|
error:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Error
|
|
description: Error message if the MCP call failed
|
|
output:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Output
|
|
description: Output result from the successful MCP call
|
|
type: object
|
|
required:
|
|
- id
|
|
- arguments
|
|
- name
|
|
- server_label
|
|
title: OpenAIResponseOutputMessageMCPCall
|
|
description: "Model Context Protocol (MCP) call output message for OpenAI responses.\n\n:param id: Unique identifier for this MCP call\n:param type: Tool call type identifier, always \"mcp_call\"\n:param arguments: JSON string containing the MCP call arguments\n:param name: Name of the MCP method being called\n:param server_label: Label identifying the MCP server handling the call\n:param error: (Optional) Error message if the MCP call failed\n:param output: (Optional) Output result from the successful MCP call"
|
|
OpenAIResponseOutputMessageMCPListTools:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier for this MCP list tools operation
|
|
type:
|
|
type: string
|
|
const: mcp_list_tools
|
|
title: Type
|
|
description: Tool call type identifier, always "mcp_list_tools"
|
|
default: mcp_list_tools
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
description: Label identifying the MCP server providing the tools
|
|
tools:
|
|
items:
|
|
$ref: '#/components/schemas/MCPListToolsTool'
|
|
type: array
|
|
title: Tools
|
|
description: List of available tools provided by the MCP server
|
|
type: object
|
|
required:
|
|
- id
|
|
- server_label
|
|
- tools
|
|
title: OpenAIResponseOutputMessageMCPListTools
|
|
description: "MCP list tools output message containing available tools from an MCP server.\n\n:param id: Unique identifier for this MCP list tools operation\n:param type: Tool call type identifier, always \"mcp_list_tools\"\n:param server_label: Label identifying the MCP server providing the tools\n:param tools: List of available tools provided by the MCP server"
|
|
OpenAIResponseOutputMessageWebSearchToolCall:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier for this tool call
|
|
status:
|
|
type: string
|
|
title: Status
|
|
description: Current status of the web search operation
|
|
type:
|
|
type: string
|
|
const: web_search_call
|
|
title: Type
|
|
description: Tool call type identifier, always "web_search_call"
|
|
default: web_search_call
|
|
type: object
|
|
required:
|
|
- id
|
|
- status
|
|
title: OpenAIResponseOutputMessageWebSearchToolCall
|
|
description: "Web search tool call output message for OpenAI responses.\n\n:param id: Unique identifier for this tool call\n:param status: Current status of the web search operation\n:param type: Tool call type identifier, always \"web_search_call\""
|
|
OpenAIResponsePrompt:
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: Id
|
|
description: Unique identifier of the prompt template
|
|
variables:
|
|
anyOf:
|
|
- additionalProperties:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
|
|
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
|
|
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
|
|
type: object
|
|
- type: 'null'
|
|
title: Variables
|
|
description: Dictionary of variable names to OpenAIResponseInputMessageContent structure for template substitution. The substitution values can either be strings, or other Response input types like images or files.
|
|
version:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Version
|
|
description: Version number of the prompt to use (defaults to latest if not specified)
|
|
type: object
|
|
required:
|
|
- id
|
|
title: OpenAIResponsePrompt
|
|
description: "OpenAI compatible Prompt object that is used in OpenAI responses.\n\n:param id: Unique identifier of the prompt template\n:param variables: Dictionary of variable names to OpenAIResponseInputMessageContent structure for template substitution. The substitution values can either be strings, or other Response input types\nlike images or files.\n:param version: Version number of the prompt to use (defaults to latest if not specified)"
|
|
OpenAIResponseText:
|
|
properties:
|
|
format:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseTextFormat'
|
|
- type: 'null'
|
|
description: Text format configuration specifying output format requirements
|
|
type: object
|
|
title: OpenAIResponseText
|
|
description: "Text response configuration for OpenAI responses.\n\n:param format: (Optional) Text format configuration specifying output format requirements"
|
|
OpenAIResponseTextFormat:
|
|
properties:
|
|
type:
|
|
anyOf:
|
|
- type: string
|
|
const: text
|
|
- type: string
|
|
const: json_schema
|
|
- type: string
|
|
const: json_object
|
|
title: Type
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Schema
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Description
|
|
strict:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Strict
|
|
type: object
|
|
title: OpenAIResponseTextFormat
|
|
description: "Configuration for Responses API text format.\n\n:param type: Must be \"text\", \"json_schema\", or \"json_object\" to identify the format type\n:param name: The name of the response format. Only used for json_schema.\n:param schema: The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model. Only used for json_schema.\n:param description: (Optional) A description of the response format. Only used for json_schema.\n:param strict: (Optional) Whether to strictly enforce the JSON schema. If true, the response must match the schema exactly. Only used for json_schema."
|
|
OpenAIResponseToolMCP:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: mcp
|
|
title: Type
|
|
description: Tool type identifier, always "mcp"
|
|
default: mcp
|
|
server_label:
|
|
type: string
|
|
title: Server Label
|
|
description: Label to identify this MCP server
|
|
allowed_tools:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- $ref: '#/components/schemas/AllowedToolsFilter'
|
|
- type: 'null'
|
|
title: Allowed Tools
|
|
description: Restriction on which tools can be used from this server
|
|
type: object
|
|
required:
|
|
- server_label
|
|
title: OpenAIResponseToolMCP
|
|
description: "Model Context Protocol (MCP) tool configuration for OpenAI response object.\n\n:param type: Tool type identifier, always \"mcp\"\n:param server_label: Label to identify this MCP server\n:param allowed_tools: (Optional) Restriction on which tools can be used from this server"
|
|
OpenAIResponseUsage:
|
|
properties:
|
|
input_tokens:
|
|
type: integer
|
|
title: Input Tokens
|
|
description: Number of tokens in the input
|
|
output_tokens:
|
|
type: integer
|
|
title: Output Tokens
|
|
description: Number of tokens in the output
|
|
total_tokens:
|
|
type: integer
|
|
title: Total Tokens
|
|
description: Total tokens used (input + output)
|
|
input_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails'
|
|
- type: 'null'
|
|
description: Detailed breakdown of input token usage
|
|
output_tokens_details:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails'
|
|
- type: 'null'
|
|
description: Detailed breakdown of output token usage
|
|
type: object
|
|
required:
|
|
- input_tokens
|
|
- output_tokens
|
|
- total_tokens
|
|
title: OpenAIResponseUsage
|
|
description: "Usage information for OpenAI response.\n\n:param input_tokens: Number of tokens in the input\n:param output_tokens: Number of tokens in the output\n:param total_tokens: Total tokens used (input + output)\n:param input_tokens_details: Detailed breakdown of input token usage\n:param output_tokens_details: Detailed breakdown of output token usage"
|
|
OpenAIResponseUsageInputTokensDetails:
|
|
properties:
|
|
cached_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Cached Tokens
|
|
description: Number of tokens retrieved from cache
|
|
type: object
|
|
title: OpenAIResponseUsageInputTokensDetails
|
|
description: "Token details for input tokens in OpenAI response usage.\n\n:param cached_tokens: Number of tokens retrieved from cache"
|
|
OpenAIResponseUsageOutputTokensDetails:
|
|
properties:
|
|
reasoning_tokens:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Reasoning Tokens
|
|
description: Number of tokens used for reasoning (o1/o3 models)
|
|
type: object
|
|
title: OpenAIResponseUsageOutputTokensDetails
|
|
description: "Token details for output tokens in OpenAI response usage.\n\n:param reasoning_tokens: Number of tokens used for reasoning (o1/o3 models)"
|
|
OpenAISystemMessageParam:
|
|
properties:
|
|
role:
|
|
type: string
|
|
const: system
|
|
title: Role
|
|
default: system
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: Content
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
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'
|
|
title: Bytes
|
|
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.\n\n:token: The token\n:bytes: (Optional) The bytes for the token\n:logprob: The log probability of the token\n: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: Content
|
|
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'
|
|
title: Bytes
|
|
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.\n\n:token: The token\n:bytes: (Optional) The bytes for the token\n: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'
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
- $ref: '#/components/schemas/OpenAIFile'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file: '#/components/schemas/OpenAIFile'
|
|
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: Content
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
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'
|
|
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
- $ref: '#/components/schemas/OpenAIFile'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
file: '#/components/schemas/OpenAIFile'
|
|
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
|
|
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
|
|
type: array
|
|
title: Content
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
type: object
|
|
required:
|
|
- content
|
|
title: OpenAIUserMessageParam
|
|
description: A message from the user in an OpenAI-compatible chat completion request.
|
|
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
|
|
Prompt:
|
|
properties:
|
|
prompt:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Prompt
|
|
description: The system prompt text with variable placeholders. Variables are only supported when using the Responses API.
|
|
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 formatted as 'pmpt_<48-digit-hash>'.
|
|
variables:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Variables
|
|
description: List of prompt 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 for this prompt.
|
|
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
|
|
description: The API name this provider implements
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: Unique identifier for the provider
|
|
provider_type:
|
|
type: string
|
|
title: Provider Type
|
|
description: The type of provider implementation
|
|
config:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Config
|
|
description: Configuration parameters for the provider
|
|
health:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Health
|
|
description: Current health status of the provider
|
|
type: object
|
|
required:
|
|
- api
|
|
- provider_id
|
|
- provider_type
|
|
- config
|
|
- health
|
|
title: ProviderInfo
|
|
description: Information about a registered provider including its configuration and health status.
|
|
QueryChunksRequest:
|
|
properties:
|
|
vector_store_id:
|
|
type: string
|
|
title: Vector Store Id
|
|
description: The identifier of the vector database to query.
|
|
query:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
title: Query
|
|
description: The query to search for.
|
|
params:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Params
|
|
description: The parameters of the query.
|
|
type: object
|
|
required:
|
|
- vector_store_id
|
|
- query
|
|
title: QueryChunksRequest
|
|
description: Request to query chunks from a vector database.
|
|
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.
|
|
RAGDocument:
|
|
properties:
|
|
document_id:
|
|
type: string
|
|
title: Document Id
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Input'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Input'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
- $ref: '#/components/schemas/URL'
|
|
title: Content
|
|
mime_type:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Mime Type
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- content
|
|
title: RAGDocument
|
|
description: "A document to be used for document ingestion in the RAG Tool.\n\n:param document_id: The unique identifier for the document.\n:param content: The content of the document.\n:param mime_type: The MIME type of the document.\n:param metadata: Additional metadata for the document."
|
|
RAGQueryConfig:
|
|
properties:
|
|
query_generator_config:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/DefaultRAGQueryGeneratorConfig'
|
|
- $ref: '#/components/schemas/LLMRAGQueryGeneratorConfig'
|
|
title: Query Generator Config
|
|
default:
|
|
type: default
|
|
separator: ' '
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
default: '#/components/schemas/DefaultRAGQueryGeneratorConfig'
|
|
llm: '#/components/schemas/LLMRAGQueryGeneratorConfig'
|
|
max_tokens_in_context:
|
|
type: integer
|
|
title: Max Tokens In Context
|
|
default: 4096
|
|
max_chunks:
|
|
type: integer
|
|
title: Max Chunks
|
|
default: 5
|
|
chunk_template:
|
|
type: string
|
|
title: Chunk Template
|
|
default: "Result {index}\nContent: {chunk.content}\nMetadata: {metadata}\n"
|
|
mode:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/RAGSearchMode'
|
|
- type: 'null'
|
|
default: vector
|
|
ranker:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/RRFRanker'
|
|
- $ref: '#/components/schemas/WeightedRanker'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
rrf: '#/components/schemas/RRFRanker'
|
|
weighted: '#/components/schemas/WeightedRanker'
|
|
- type: 'null'
|
|
title: Ranker
|
|
type: object
|
|
title: RAGQueryConfig
|
|
description: "Configuration for the RAG query generation.\n\n:param query_generator_config: Configuration for the query generator.\n:param max_tokens_in_context: Maximum number of tokens in the context.\n:param max_chunks: Maximum number of chunks to retrieve.\n:param chunk_template: Template for formatting each retrieved chunk in the context.\n Available placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk content string), {metadata} (chunk metadata dict).\n Default: \"Result {index}\\nContent: {chunk.content}\\nMetadata: {metadata}\\n\"\n:param mode: Search mode for retrieval—either \"vector\", \"keyword\", or \"hybrid\". Default \"vector\".\n:param ranker: Configuration for the ranker to use in hybrid search. Defaults to RRF ranker."
|
|
RAGQueryResult:
|
|
properties:
|
|
content:
|
|
anyOf:
|
|
- type: string
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
- type: 'null'
|
|
title: Content
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
title: RAGQueryResult
|
|
description: "Result of a RAG query containing retrieved content and metadata.\n\n:param content: (Optional) The retrieved content from the query\n:param metadata: Additional metadata about the query result"
|
|
RAGSearchMode:
|
|
type: string
|
|
enum:
|
|
- vector
|
|
- keyword
|
|
- hybrid
|
|
title: RAGSearchMode
|
|
description: "Search modes for RAG query retrieval:\n- VECTOR: Uses vector similarity search for semantic matching\n- KEYWORD: Uses keyword-based search for exact matching\n- HYBRID: Combines both vector and keyword search for better results"
|
|
RRFRanker:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: rrf
|
|
title: Type
|
|
default: rrf
|
|
impact_factor:
|
|
type: number
|
|
title: Impact Factor
|
|
default: 60.0
|
|
minimum: 0.0
|
|
type: object
|
|
title: RRFRanker
|
|
description: "Reciprocal Rank Fusion (RRF) ranker configuration.\n\n:param type: The type of ranker, always \"rrf\"\n:param impact_factor: The impact factor for RRF scoring. Higher values give more weight to higher-ranked results.\n Must be greater than 0"
|
|
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.
|
|
RegisterModelRequest:
|
|
properties:
|
|
model_id:
|
|
type: string
|
|
title: Model Id
|
|
description: The identifier of the model to register.
|
|
provider_model_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Model Id
|
|
description: The identifier of the model in the provider.
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Id
|
|
description: The identifier of the provider.
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
description: Any additional metadata for this model.
|
|
model_type:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/ModelType'
|
|
- type: 'null'
|
|
description: The type of model to register.
|
|
type: object
|
|
required:
|
|
- model_id
|
|
title: RegisterModelRequest
|
|
description: Request model for registering a new model.
|
|
RegisterScoringFunctionRequest:
|
|
properties:
|
|
scoring_fn_id:
|
|
type: string
|
|
title: Scoring Fn Id
|
|
description: The ID of the scoring function to register
|
|
description:
|
|
type: string
|
|
title: Description
|
|
description: The description of the scoring function
|
|
return_type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/StringType'
|
|
- $ref: '#/components/schemas/NumberType'
|
|
- $ref: '#/components/schemas/BooleanType'
|
|
- $ref: '#/components/schemas/ArrayType'
|
|
- $ref: '#/components/schemas/ObjectType'
|
|
- $ref: '#/components/schemas/JsonType'
|
|
- $ref: '#/components/schemas/UnionType'
|
|
- $ref: '#/components/schemas/ChatCompletionInputType'
|
|
- $ref: '#/components/schemas/CompletionInputType'
|
|
- $ref: '#/components/schemas/AgentTurnInputType'
|
|
title: Return Type
|
|
description: The return type of the scoring function
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
agent_turn_input: '#/components/schemas/AgentTurnInputType'
|
|
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'
|
|
provider_scoring_fn_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Scoring Fn Id
|
|
description: The ID of the provider scoring function to use for the scoring function
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Id
|
|
description: The ID of the provider to use for the scoring function
|
|
params:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
- type: 'null'
|
|
title: Params
|
|
description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval
|
|
type: object
|
|
required:
|
|
- scoring_fn_id
|
|
- description
|
|
- return_type
|
|
title: RegisterScoringFunctionRequest
|
|
description: Request model for registering a scoring function.
|
|
RegisterShieldRequest:
|
|
properties:
|
|
shield_id:
|
|
type: string
|
|
title: Shield Id
|
|
description: The identifier of the shield to register
|
|
provider_shield_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Shield Id
|
|
description: The identifier of the shield in the provider
|
|
provider_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Id
|
|
description: The identifier of the provider
|
|
params:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Params
|
|
description: The parameters of the shield
|
|
type: object
|
|
required:
|
|
- shield_id
|
|
title: RegisterShieldRequest
|
|
description: Request model for registering a shield.
|
|
RegisterToolGroupRequest:
|
|
properties:
|
|
toolgroup_id:
|
|
type: string
|
|
title: Toolgroup Id
|
|
description: The ID of the tool group to register
|
|
provider_id:
|
|
type: string
|
|
title: Provider Id
|
|
description: The ID of the provider to use for the tool group
|
|
mcp_endpoint:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
- type: 'null'
|
|
description: The MCP endpoint to use for the tool group
|
|
args:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Args
|
|
description: A dictionary of arguments to pass to the tool group
|
|
type: object
|
|
required:
|
|
- toolgroup_id
|
|
- provider_id
|
|
title: RegisterToolGroupRequest
|
|
description: Request model for registering a tool group.
|
|
ResponseGuardrailSpec:
|
|
properties:
|
|
type:
|
|
type: string
|
|
title: Type
|
|
description: The type/identifier of the guardrail.
|
|
type: object
|
|
required:
|
|
- type
|
|
title: ResponseGuardrailSpec
|
|
description: Specification for a guardrail to apply during response generation.
|
|
RouteInfo:
|
|
properties:
|
|
route:
|
|
type: string
|
|
title: Route
|
|
description: The API endpoint path
|
|
method:
|
|
type: string
|
|
title: Method
|
|
description: HTTP method for the route
|
|
provider_types:
|
|
items:
|
|
type: string
|
|
type: array
|
|
title: Provider Types
|
|
description: List of provider types that implement this route
|
|
type: object
|
|
required:
|
|
- route
|
|
- method
|
|
- provider_types
|
|
title: RouteInfo
|
|
description: Information about an API route including its path, method, and implementing providers.
|
|
RunModerationRequest:
|
|
properties:
|
|
input:
|
|
anyOf:
|
|
- type: string
|
|
- items:
|
|
type: string
|
|
type: array
|
|
title: Input
|
|
description: Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models.
|
|
model:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Model
|
|
description: The content moderation model you would like to use.
|
|
type: object
|
|
required:
|
|
- input
|
|
title: RunModerationRequest
|
|
description: Request model for running moderation.
|
|
RunShieldRequest:
|
|
properties:
|
|
shield_id:
|
|
type: string
|
|
title: Shield Id
|
|
description: The identifier of the shield to run.
|
|
messages:
|
|
items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/OpenAIUserMessageParam-Input'
|
|
- $ref: '#/components/schemas/OpenAISystemMessageParam'
|
|
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input'
|
|
- $ref: '#/components/schemas/OpenAIToolMessageParam'
|
|
- $ref: '#/components/schemas/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'
|
|
type: array
|
|
title: Messages
|
|
description: The messages to run the shield on.
|
|
params:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Params
|
|
description: The parameters of the shield.
|
|
type: object
|
|
required:
|
|
- shield_id
|
|
- messages
|
|
- params
|
|
title: RunShieldRequest
|
|
description: Request model for running a shield.
|
|
RunShieldResponse:
|
|
properties:
|
|
violation:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/SafetyViolation'
|
|
- type: 'null'
|
|
description: Safety violation detected by the shield, if any.
|
|
type: object
|
|
title: RunShieldResponse
|
|
description: Response from running a safety shield.
|
|
SafetyViolation:
|
|
properties:
|
|
violation_level:
|
|
$ref: '#/components/schemas/ViolationLevel'
|
|
description: Severity level of the violation.
|
|
user_message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: User Message
|
|
description: Message to convey to the user about the violation.
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Additional metadata including specific violation codes for debugging and telemetry.
|
|
type: object
|
|
required:
|
|
- violation_level
|
|
title: SafetyViolation
|
|
description: Details of a safety violation detected by content moderation.
|
|
ScoreBatchRequest:
|
|
properties:
|
|
dataset_id:
|
|
type: string
|
|
title: Dataset Id
|
|
description: The ID of the dataset to score
|
|
scoring_functions:
|
|
additionalProperties:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
- type: 'null'
|
|
type: object
|
|
title: Scoring Functions
|
|
description: The scoring functions to use for the scoring
|
|
save_results_dataset:
|
|
type: boolean
|
|
title: Save Results Dataset
|
|
description: Whether to save the results to a dataset
|
|
default: false
|
|
type: object
|
|
required:
|
|
- dataset_id
|
|
- scoring_functions
|
|
title: ScoreBatchRequest
|
|
description: Request for batch scoring operations.
|
|
ScoreBatchResponse:
|
|
properties:
|
|
dataset_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Dataset Id
|
|
description: The identifier of the dataset that was scored
|
|
results:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
title: Results
|
|
description: A map of scoring function name to ScoringResult
|
|
type: object
|
|
required:
|
|
- results
|
|
title: ScoreBatchResponse
|
|
description: Response from batch scoring operations on datasets.
|
|
ScoreRequest:
|
|
properties:
|
|
input_rows:
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
title: Input Rows
|
|
description: The rows to score
|
|
scoring_functions:
|
|
additionalProperties:
|
|
anyOf:
|
|
- oneOf:
|
|
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
- type: 'null'
|
|
type: object
|
|
title: Scoring Functions
|
|
description: The scoring functions to use for the scoring
|
|
type: object
|
|
required:
|
|
- input_rows
|
|
- scoring_functions
|
|
title: ScoreRequest
|
|
description: Request for scoring a list of rows.
|
|
ScoreResponse:
|
|
properties:
|
|
results:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/ScoringResult'
|
|
type: object
|
|
title: Results
|
|
description: A map of scoring function name to ScoringResult
|
|
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'
|
|
title: Provider Resource Id
|
|
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'
|
|
title: Description
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
description: Any additional metadata for this definition
|
|
return_type:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/StringType'
|
|
- $ref: '#/components/schemas/NumberType'
|
|
- $ref: '#/components/schemas/BooleanType'
|
|
- $ref: '#/components/schemas/ArrayType'
|
|
- $ref: '#/components/schemas/ObjectType'
|
|
- $ref: '#/components/schemas/JsonType'
|
|
- $ref: '#/components/schemas/UnionType'
|
|
- $ref: '#/components/schemas/ChatCompletionInputType'
|
|
- $ref: '#/components/schemas/CompletionInputType'
|
|
- $ref: '#/components/schemas/AgentTurnInputType'
|
|
title: Return Type
|
|
description: The return type of the deterministic function
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
agent_turn_input: '#/components/schemas/AgentTurnInputType'
|
|
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'
|
|
- $ref: '#/components/schemas/RegexParserScoringFnParams'
|
|
- $ref: '#/components/schemas/BasicScoringFnParams'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
basic: '#/components/schemas/BasicScoringFnParams'
|
|
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
|
|
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
|
|
- 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
|
|
description: The scoring result for each row. Each row is a map of column name to value
|
|
aggregated_results:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Aggregated Results
|
|
description: Map of metric name to aggregated value
|
|
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'
|
|
title: Ranker
|
|
score_threshold:
|
|
anyOf:
|
|
- type: number
|
|
- type: 'null'
|
|
title: Score Threshold
|
|
default: 0.0
|
|
type: object
|
|
title: SearchRankingOptions
|
|
description: Options for ranking and filtering search results.
|
|
SetDefaultVersionRequest:
|
|
properties:
|
|
version:
|
|
type: integer
|
|
title: Version
|
|
description: The version to set as default.
|
|
type: object
|
|
required:
|
|
- version
|
|
title: SetDefaultVersionRequest
|
|
description: Request model for setting a prompt version as default.
|
|
Shield:
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: Identifier
|
|
description: Unique identifier for this resource in llama stack
|
|
provider_resource_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Provider Resource Id
|
|
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
|
|
description: The resource type, always shield
|
|
default: shield
|
|
params:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Params
|
|
description: Configuration parameters for the shield
|
|
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.\n\n:param type: Discriminator type. Always \"string\""
|
|
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'
|
|
title: Toolgroup Id
|
|
description: ID of the tool group this tool belongs to
|
|
name:
|
|
type: string
|
|
title: Name
|
|
description: Name of the tool
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Description
|
|
description: Human-readable description of what the tool does
|
|
input_schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Input Schema
|
|
description: JSON Schema for tool inputs (MCP inputSchema)
|
|
output_schema:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Output Schema
|
|
description: JSON Schema for tool outputs (MCP outputSchema)
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
description: Additional metadata about the tool
|
|
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'
|
|
title: Provider Resource Id
|
|
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
|
|
description: Type of resource, always 'tool_group'
|
|
default: tool_group
|
|
mcp_endpoint:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
- type: 'null'
|
|
description: Model Context Protocol endpoint for remote tools
|
|
args:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Args
|
|
description: Additional arguments for the tool group
|
|
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'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
- items:
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ImageContentItem-Output'
|
|
- $ref: '#/components/schemas/TextContentItem'
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
image: '#/components/schemas/ImageContentItem-Output'
|
|
text: '#/components/schemas/TextContentItem'
|
|
type: array
|
|
- type: 'null'
|
|
title: Content
|
|
description: The output content from the tool execution
|
|
error_message:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Error Message
|
|
description: Error message if the tool execution failed
|
|
error_code:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Error Code
|
|
description: Numeric error code if the tool execution failed
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
description: Additional metadata about the tool execution
|
|
type: object
|
|
title: ToolInvocationResult
|
|
description: Result of a tool invocation.
|
|
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.\n\n:param type: Discriminator type. Always \"union\""
|
|
UpdatePromptRequest:
|
|
properties:
|
|
prompt:
|
|
type: string
|
|
title: Prompt
|
|
description: The updated prompt text content.
|
|
version:
|
|
type: integer
|
|
title: Version
|
|
description: The current version of the prompt being updated.
|
|
variables:
|
|
anyOf:
|
|
- items:
|
|
type: string
|
|
type: array
|
|
- type: 'null'
|
|
title: Variables
|
|
description: Updated list of variable names that can be used in the prompt template.
|
|
set_as_default:
|
|
type: boolean
|
|
title: Set As Default
|
|
description: Set the new version as the default (default=True).
|
|
default: true
|
|
type: object
|
|
required:
|
|
- prompt
|
|
- version
|
|
title: UpdatePromptRequest
|
|
description: Request model for updating an existing prompt.
|
|
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
|
|
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:
|
|
anyOf:
|
|
- type: string
|
|
const: completed
|
|
- type: string
|
|
const: in_progress
|
|
- type: string
|
|
const: cancelled
|
|
- type: string
|
|
const: failed
|
|
title: Status
|
|
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.
|
|
VectorStoreFileContentsResponse:
|
|
properties:
|
|
file_id:
|
|
type: string
|
|
title: File Id
|
|
filename:
|
|
type: string
|
|
title: Filename
|
|
attributes:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Attributes
|
|
content:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreContent'
|
|
type: array
|
|
title: Content
|
|
type: object
|
|
required:
|
|
- file_id
|
|
- filename
|
|
- attributes
|
|
- content
|
|
title: VectorStoreFileContentsResponse
|
|
description: Response from retrieving the contents 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:
|
|
anyOf:
|
|
- type: string
|
|
const: server_error
|
|
- type: string
|
|
const: rate_limit_exceeded
|
|
title: Code
|
|
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'
|
|
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
|
|
title: Chunking Strategy
|
|
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'
|
|
- type: 'null'
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
const: completed
|
|
- type: string
|
|
const: in_progress
|
|
- type: string
|
|
const: cancelled
|
|
- type: string
|
|
const: failed
|
|
title: Status
|
|
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'
|
|
title: First Id
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Last Id
|
|
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'
|
|
title: First Id
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Last Id
|
|
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'
|
|
title: First Id
|
|
last_id:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Last Id
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
type: object
|
|
required:
|
|
- data
|
|
title: VectorStoreListResponse
|
|
description: Response from listing vector stores.
|
|
VectorStoreModifyRequest:
|
|
properties:
|
|
name:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Name
|
|
expires_after:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Expires After
|
|
metadata:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
- type: 'null'
|
|
title: Metadata
|
|
type: object
|
|
title: VectorStoreModifyRequest
|
|
description: Request to modify a vector store.
|
|
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'
|
|
title: Name
|
|
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'
|
|
title: Expires After
|
|
expires_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Expires At
|
|
last_active_at:
|
|
anyOf:
|
|
- type: integer
|
|
- type: 'null'
|
|
title: Last Active At
|
|
metadata:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Metadata
|
|
type: object
|
|
required:
|
|
- id
|
|
- created_at
|
|
- file_counts
|
|
title: VectorStoreObject
|
|
description: OpenAI Vector Store object.
|
|
VectorStoreSearchResponse:
|
|
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
|
|
type: object
|
|
- type: 'null'
|
|
title: Attributes
|
|
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:
|
|
type: string
|
|
title: Search Query
|
|
data:
|
|
items:
|
|
$ref: '#/components/schemas/VectorStoreSearchResponse'
|
|
type: array
|
|
title: Data
|
|
has_more:
|
|
type: boolean
|
|
title: Has More
|
|
default: false
|
|
next_page:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Next Page
|
|
type: object
|
|
required:
|
|
- search_query
|
|
- data
|
|
title: VectorStoreSearchResponsePage
|
|
description: Paginated response from searching a vector store.
|
|
VersionInfo:
|
|
properties:
|
|
version:
|
|
type: string
|
|
title: Version
|
|
description: Version number of the service
|
|
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.\n\n:cvar INFO: Informational level violation that does not require action\n:cvar WARN: Warning level violation that suggests caution but allows continuation\n:cvar ERROR: Error level violation that requires blocking or intervention"
|
|
WeightedRanker:
|
|
properties:
|
|
type:
|
|
type: string
|
|
const: weighted
|
|
title: Type
|
|
default: weighted
|
|
alpha:
|
|
type: number
|
|
maximum: 1.0
|
|
minimum: 0.0
|
|
title: Alpha
|
|
description: Weight factor between 0 and 1. 0 means only keyword scores, 1 means only vector scores.
|
|
default: 0.5
|
|
type: object
|
|
title: WeightedRanker
|
|
description: "Weighted ranker configuration that combines vector and keyword scores.\n\n:param type: The type of ranker, always \"weighted\"\n:param alpha: Weight factor between 0 and 1.\n 0 means only use keyword scores,\n 1 means only use vector scores,\n values in between blend both scores."
|
|
_URLOrData:
|
|
properties:
|
|
url:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/URL'
|
|
- type: 'null'
|
|
data:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
contentEncoding: base64
|
|
title: Data
|
|
type: object
|
|
title: _URLOrData
|
|
description: A URL or a base64 encoded string.
|