mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-05 02:17:31 +00:00
18640 lines
No EOL
539 KiB
JSON
18640 lines
No EOL
539 KiB
JSON
{
|
|
"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/agents": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List all agents.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "list_agents_v1_agents_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "start_index",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"title": "Start Index"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PaginatedResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PaginatedResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create an agent with the given configuration.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "create_agent_v1_agents_post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgentConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "An AgentCreateResponse with the agent ID.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgentCreateResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Delete an agent by its ID and its associated sessions and turns.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "delete_agent_v1_agents__agent_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the agent to delete."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Describe an agent by its ID.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_agent_v1_agents__agent_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"description": "ID of the agent."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An Agent of the agent.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Agent"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/session": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create a new session for an agent.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "create_agent_session_v1_agents__agent_id__session_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/__main_____agents_agent_id_session_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "An AgentSessionCreateResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgentSessionCreateResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the agent to create the session for."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/session/{session_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Delete an agent session by its ID and its associated turns.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "delete_agents_session_v1_agents__agent_id__session__session_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the session to delete."
|
|
},
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the agent to delete the session for."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve an agent session by its ID.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_agents_session_v1_agents__agent_id__session__session_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "turn_ids",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Turn Ids"
|
|
}
|
|
},
|
|
{
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
},
|
|
"description": "The ID of the session to get."
|
|
},
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"description": "The ID of the agent to get the session for."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A Session.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Session"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/session/{session_id}/turn": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create a new turn for an agent.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "create_agent_turn_v1_agents__agent_id__session__session_id__turn_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/__main_____agents_agent_id_session_session_id_turn_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "If stream=False, returns a Turn object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Turn"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the agent to create the turn for."
|
|
},
|
|
{
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the session to create the turn for."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve an agent turn by its ID.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_agents_turn_v1_agents__agent_id__session__session_id__turn__turn_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"description": "The ID of the agent to get the turn for."
|
|
},
|
|
{
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
},
|
|
"description": "The ID of the session to get the turn for."
|
|
},
|
|
{
|
|
"name": "turn_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"description": "The ID of the turn to get."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A Turn.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Turn"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}/resume": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Resume an agent turn with executed tool call responses.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "resume_agent_turn_v1_agents__agent_id__session__session_id__turn__turn_id__resume_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/__main_____agents_agent_id_session_session_id_turn_turn_id_resume_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A Turn object if stream is False, otherwise an AsyncIterator of AgentTurnResponseStreamChunk objects.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Turn"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the agent to resume."
|
|
},
|
|
{
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the session to resume."
|
|
},
|
|
{
|
|
"name": "turn_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the turn to resume."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}/step/{step_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve an agent step by its ID.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_agents_step_v1_agents__agent_id__session__session_id__turn__turn_id__step__step_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"description": "The ID of the agent to get the step for."
|
|
},
|
|
{
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
},
|
|
"description": "The ID of the session to get the step for."
|
|
},
|
|
{
|
|
"name": "turn_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"description": "The ID of the turn to get the step for."
|
|
},
|
|
{
|
|
"name": "step_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"description": "The ID of the step to get."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An AgentStepResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgentStepResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/agents/{agent_id}/sessions": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List all session(s) of a given agent.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "list_agent_sessions_v1_agents__agent_id__sessions_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "start_index",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"title": "Start Index"
|
|
}
|
|
},
|
|
{
|
|
"name": "agent_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"description": "The ID of the agent to list sessions for."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PaginatedResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PaginatedResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/datasetio/append-rows/{dataset_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Append rows to a dataset.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "append_rows_v1_datasetio_append_rows__dataset_id__post",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataset_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "Path parameter: dataset_id"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/datasetio/iterrows/{dataset_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get a paginated list of rows from a dataset.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "iterrows_v1_datasetio_iterrows__dataset_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "start_index",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"title": "Start Index"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataset_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Dataset Id"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PaginatedResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PaginatedResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/datasets": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List all datasets.",
|
|
"description": "Response-only endpoint for proper schema generation.",
|
|
"operationId": "list_datasets_v1_datasets_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A ListDatasetsResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListDatasetsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Register a new dataset.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "register_dataset_v1_datasets_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/__main_____datasets_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A Dataset.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/datasets/{dataset_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Unregister a dataset by its ID.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "unregister_dataset_v1_datasets__dataset_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataset_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "Path parameter: dataset_id"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get a dataset by its ID.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_dataset_v1_datasets__dataset_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "dataset_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Dataset Id"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A Dataset.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/eval/benchmarks": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List all benchmarks.",
|
|
"description": "Response-only endpoint for proper schema generation.",
|
|
"operationId": "list_benchmarks_v1_eval_benchmarks_get",
|
|
"deprecated": true,
|
|
"responses": {
|
|
"200": {
|
|
"description": "A ListBenchmarksResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListBenchmarksResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Register a benchmark.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "register_benchmark_v1_eval_benchmarks_post",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/eval/benchmarks/{benchmark_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Unregister a benchmark.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "unregister_benchmark_v1_eval_benchmarks__benchmark_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the benchmark to unregister."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get a benchmark by its ID.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_benchmark_v1_eval_benchmarks__benchmark_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Benchmark Id"
|
|
},
|
|
"description": "The ID of the benchmark to get."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A Benchmark.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Benchmark"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/eval/benchmarks/{benchmark_id}/evaluations": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Evaluate a list of rows on a benchmark.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "evaluate_rows_v1_eval_benchmarks__benchmark_id__evaluations_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BenchmarkConfig"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "EvaluateResponse object containing generations and scores.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EvaluateResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the benchmark to run the evaluation on."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/eval/benchmarks/{benchmark_id}/jobs": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Run an evaluation on a benchmark.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "run_eval_v1_eval_benchmarks__benchmark_id__jobs_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BenchmarkConfig"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The job that was created to run the evaluation.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Job"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the benchmark to run the evaluation on."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Cancel a job.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "job_cancel_v1_eval_benchmarks__benchmark_id__jobs__job_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the benchmark to run the evaluation on."
|
|
},
|
|
{
|
|
"name": "job_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the job to cancel."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get the status of a job.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "job_status_v1_eval_benchmarks__benchmark_id__jobs__job_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Benchmark Id"
|
|
},
|
|
"description": "The ID of the benchmark to run the evaluation on."
|
|
},
|
|
{
|
|
"name": "job_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Job Id"
|
|
},
|
|
"description": "The ID of the job to get the status of."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The status of the evaluation job.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Job"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}/result": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get the result of a job.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "job_result_v1_eval_benchmarks__benchmark_id__jobs__job_id__result_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "benchmark_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Benchmark Id"
|
|
},
|
|
"description": "The ID of the benchmark to run the evaluation on."
|
|
},
|
|
{
|
|
"name": "job_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Job Id"
|
|
},
|
|
"description": "The ID of the job to get the result of."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The result of the job.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EvaluateResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/batches": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List all batches for the current user.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "list_batches_v1_openai_v1_batches_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"title": "Limit"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of batch objects.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListBatchesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create a new batch for processing multiple API requests.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "create_batch_v1_openai_v1_batches_post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_batches_Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The created batch object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Batch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/batches/{batch_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve information about a specific batch.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "retrieve_batch_v1_openai_v1_batches__batch_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "batch_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
},
|
|
"description": "The ID of the batch to retrieve."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The batch object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Batch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/batches/{batch_id}/cancel": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Cancel a batch that is in progress.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "cancel_batch_v1_openai_v1_batches__batch_id__cancel_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_batches_batch_id_cancel_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "The updated batch object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Batch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "batch_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the batch to cancel."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/openai/v1/chat/completions": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List chat completions.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "list_chat_completions_v1_openai_v1_chat_completions_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "model",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order",
|
|
"default": "desc"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A ListOpenAIChatCompletionResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListOpenAIChatCompletionResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create chat completions.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_chat_completion_v1_openai_v1_chat_completions_post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionRequestWithExtraBody"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIChatCompletion.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletion"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/chat/completions/{completion_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get chat completion.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_chat_completion_v1_openai_v1_chat_completions__completion_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "completion_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Completion Id"
|
|
},
|
|
"description": "ID of the chat completion."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A OpenAICompletionWithInputMessages.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAICompletionWithInputMessages"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/completions": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create completion.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_completion_v1_openai_v1_completions_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAICompletionRequestWithExtraBody"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAICompletion.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAICompletion"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/openai/v1/embeddings": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create embeddings.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_embeddings_v1_openai_v1_embeddings_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIEmbeddingsResponse containing the embeddings.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIEmbeddingsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/openai/v1/files": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List files.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_list_files_v1_openai_v1_files_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "purpose",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIFilePurpose"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 10000,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order",
|
|
"default": "desc"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An ListOpenAIFileResponse containing the list of files.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListOpenAIFileResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Upload file.",
|
|
"description": "Response-only endpoint for proper schema generation.",
|
|
"operationId": "openai_upload_file_v1_openai_v1_files_post",
|
|
"deprecated": true,
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIFileObject representing the uploaded file.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIFileObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/files/{file_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Delete file.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_delete_file_v1_openai_v1_files__file_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "file_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"description": "The ID of the file to use for this request."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIFileDeleteResponse indicating successful deletion.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIFileDeleteResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve file.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_retrieve_file_v1_openai_v1_files__file_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "file_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"description": "The ID of the file to use for this request."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIFileObject containing file information.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIFileObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/files/{file_id}/content": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve file content.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "openai_retrieve_file_content_v1_openai_v1_files__file_id__content_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
{
|
|
"name": "file_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the file to use for this request."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The raw file content as a binary response.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/models": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List models using the OpenAI API.",
|
|
"description": "Response-only endpoint for proper schema generation.",
|
|
"operationId": "openai_list_models_v1_openai_v1_models_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A OpenAIListModelsResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIListModelsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/openai/v1/moderations": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create moderation.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "run_moderation_v1_openai_v1_moderations_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_moderations_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A moderation object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModerationObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/openai/v1/responses": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List all responses.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "list_openai_responses_v1_openai_v1_responses_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "model",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 50,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order",
|
|
"default": "desc"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A ListOpenAIResponseObject.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListOpenAIResponseObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create a model response.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "create_openai_response_v1_openai_v1_responses_post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_responses_Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIResponseObject.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/responses/{response_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Delete a response.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "delete_openai_response_v1_openai_v1_responses__response_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "response_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Response Id"
|
|
},
|
|
"description": "The ID of the OpenAI response to delete."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIDeleteResponseObject",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIDeleteResponseObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get a model response.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_openai_response_v1_openai_v1_responses__response_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "response_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Response Id"
|
|
},
|
|
"description": "The ID of the OpenAI response to retrieve."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An OpenAIResponseObject.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/responses/{response_id}/input_items": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List input items.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "list_openai_response_input_items_v1_openai_v1_responses__response_id__input_items_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Before"
|
|
}
|
|
},
|
|
{
|
|
"name": "include",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Include"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order",
|
|
"default": "desc"
|
|
}
|
|
},
|
|
{
|
|
"name": "response_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Response Id"
|
|
},
|
|
"description": "The ID of the response to retrieve input items for."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "An ListOpenAIResponseInputItem.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListOpenAIResponseInputItem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Returns a list of vector stores.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_list_vector_stores_v1_openai_v1_vector_stores_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Before"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "desc",
|
|
"title": "Order"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreListResponse containing the list of vector stores.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreListResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Creates a vector store.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_create_vector_store_v1_openai_v1_vector_stores_post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreObject representing the created vector store.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Delete a vector store.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_delete_vector_store_v1_openai_v1_vector_stores__vector_store_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"description": "The ID of the vector store to delete."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreDeleteResponse indicating the deletion status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreDeleteResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieves a vector store.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_retrieve_vector_store_v1_openai_v1_vector_stores__vector_store_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"description": "The ID of the vector store to retrieve."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreObject representing the vector store.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Updates a vector store.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_update_vector_store_v1_openai_v1_vector_stores__vector_store_id__post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_vector_stores_vector_store_id_Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreObject representing the updated vector store.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the vector store to update."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/file_batches": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Create a vector store file batch.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_create_vector_store_file_batch_v1_openai_v1_vector_stores__vector_store_id__file_batches_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileBatchObject representing the created file batch.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileBatchObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the vector store to create the file batch for."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieve a vector store file batch.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_retrieve_vector_store_file_batch_v1_openai_v1_vector_stores__vector_store_id__file_batches__batch_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "batch_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
},
|
|
"description": "The ID of the file batch to retrieve."
|
|
},
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"description": "The ID of the vector store containing the file batch."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileBatchObject representing the file batch.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileBatchObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Cancels a vector store file batch.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_cancel_vector_store_file_batch_v1_openai_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_vector_stores_vector_store_id_file_batches_batch_id_cancel_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileBatchObject representing the cancelled file batch.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileBatchObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "batch_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the file batch to cancel."
|
|
},
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the vector store containing the file batch."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Returns a list of vector store files in a batch.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_list_files_in_vector_store_file_batch_v1_openai_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Before"
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Filter"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "desc",
|
|
"title": "Order"
|
|
}
|
|
},
|
|
{
|
|
"name": "batch_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
},
|
|
"description": "The ID of the file batch to list files from."
|
|
},
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"description": "The ID of the vector store containing the file batch."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFilesListInBatchResponse containing the list of files in the batch.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFilesListInBatchResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "List files in a vector store.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_list_files_in_vector_store_v1_openai_v1_vector_stores__vector_store_id__files_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "After"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Before"
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Filter"
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"title": "Limit"
|
|
}
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "desc",
|
|
"title": "Order"
|
|
}
|
|
},
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"description": "The ID of the vector store to list files from."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreListFilesResponse containing the list of files.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreListFilesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Attach a file to a vector store.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_attach_file_to_vector_store_v1_openai_v1_vector_stores__vector_store_id__files_post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_vector_stores_vector_store_id_files_Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileObject representing the attached file.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the vector store to attach the file to."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Delete a vector store file.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_delete_vector_store_file_v1_openai_v1_vector_stores__vector_store_id__files__file_id__delete",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"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",
|
|
"title": "File Id"
|
|
},
|
|
"description": "The ID of the file to delete."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileDeleteResponse indicating the deletion status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileDeleteResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieves a vector store file.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_retrieve_vector_store_file_v1_openai_v1_vector_stores__vector_store_id__files__file_id__get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"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",
|
|
"title": "File Id"
|
|
},
|
|
"description": "The ID of the file to retrieve."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileObject representing the file.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Updates a vector store file.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_update_vector_store_file_v1_openai_v1_vector_stores__vector_store_id__files__file_id__post",
|
|
"deprecated": true,
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_vector_stores_vector_store_id_files_file_id_Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreFileObject representing the updated file.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"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."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Retrieves the contents of a vector store file.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "openai_retrieve_vector_store_file_contents_v1_openai_v1_vector_stores__vector_store_id__files__file_id__content_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"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",
|
|
"title": "File Id"
|
|
},
|
|
"description": "The ID of the file to retrieve."
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of InterleavedContent representing the file contents.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreFileContentsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/openai/v1/vector_stores/{vector_store_id}/search": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Search for chunks in a vector store.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "openai_search_vector_store_v1_openai_v1_vector_stores__vector_store_id__search_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/_openai_v1_vector_stores_vector_store_id_search_Request"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A VectorStoreSearchResponse containing the search results.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/VectorStoreSearchResponsePage"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "vector_store_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ID of the vector store to search."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/post-training/job/artifacts": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get the artifacts of a training job.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_training_job_artifacts_v1_post_training_job_artifacts_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "job_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Job Uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PostTrainingJobArtifactsResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJobArtifactsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/post-training/job/cancel": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Cancel a training job.",
|
|
"description": "Generic endpoint - this would be replaced with actual implementation.",
|
|
"operationId": "cancel_training_job_v1_post_training_job_cancel_post",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "args",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Args"
|
|
}
|
|
},
|
|
{
|
|
"name": "kwargs",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"title": "Kwargs"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/post-training/job/status": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get the status of a training job.",
|
|
"description": "Query endpoint for proper schema generation.",
|
|
"operationId": "get_training_job_status_v1_post_training_job_status_get",
|
|
"deprecated": true,
|
|
"parameters": [
|
|
{
|
|
"name": "job_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"title": "Job Uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PostTrainingJobStatusResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJobStatusResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/BadRequest400",
|
|
"description": "Bad Request"
|
|
},
|
|
"429": {
|
|
"$ref": "#/components/responses/TooManyRequests429",
|
|
"description": "Too Many Requests"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/InternalServerError500",
|
|
"description": "Internal Server Error"
|
|
},
|
|
"default": {
|
|
"$ref": "#/components/responses/DefaultError",
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/post-training/jobs": {
|
|
"get": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Get all training jobs.",
|
|
"description": "Response-only endpoint for proper schema generation.",
|
|
"operationId": "get_training_jobs_v1_post_training_jobs_get",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A ListPostTrainingJobsResponse.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ListPostTrainingJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/post-training/preference-optimize": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Run preference optimization of a model.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "preference_optimize_v1_post_training_preference_optimize_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DPOAlignmentConfig"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PostTrainingJob.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJob"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"/v1/post-training/supervised-fine-tune": {
|
|
"post": {
|
|
"tags": [
|
|
"V1"
|
|
],
|
|
"summary": "Run supervised fine-tuning of a model.",
|
|
"description": "Typed endpoint for proper schema generation.",
|
|
"operationId": "supervised_fine_tune_v1_post_training_supervised_fine_tune_post",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TrainingConfig"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "A PostTrainingJob.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJob"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"$ref": "#/components/responses/BadRequest400"
|
|
},
|
|
"429": {
|
|
"description": "Too Many Requests",
|
|
"$ref": "#/components/responses/TooManyRequests429"
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"$ref": "#/components/responses/InternalServerError500"
|
|
},
|
|
"default": {
|
|
"description": "Default Response",
|
|
"$ref": "#/components/responses/DefaultError"
|
|
}
|
|
},
|
|
"deprecated": true
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"AgentCandidate": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "agent",
|
|
"title": "Type",
|
|
"default": "agent"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/AgentConfig"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"config"
|
|
],
|
|
"title": "AgentCandidate",
|
|
"description": "An agent candidate for evaluation."
|
|
},
|
|
"AgentConfig": {
|
|
"properties": {
|
|
"sampling_params": {
|
|
"$ref": "#/components/schemas/SamplingParams"
|
|
},
|
|
"input_shields": {
|
|
"title": "Input Shields",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"output_shields": {
|
|
"title": "Output Shields",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"toolgroups": {
|
|
"title": "Toolgroups",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentToolGroupWithArgs"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"client_tools": {
|
|
"title": "Client Tools",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolDef"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"tool_choice": {
|
|
"deprecated": true,
|
|
"$ref": "#/components/schemas/ToolChoice"
|
|
},
|
|
"tool_prompt_format": {
|
|
"deprecated": true,
|
|
"$ref": "#/components/schemas/ToolPromptFormat"
|
|
},
|
|
"tool_config": {
|
|
"$ref": "#/components/schemas/ToolConfig"
|
|
},
|
|
"max_infer_iters": {
|
|
"title": "Max Infer Iters",
|
|
"default": 10,
|
|
"type": "integer"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"instructions": {
|
|
"type": "string",
|
|
"title": "Instructions"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"enable_session_persistence": {
|
|
"title": "Enable Session Persistence",
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"response_format": {
|
|
"title": "Response Format",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/JsonSchemaResponseFormat"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GrammarResponseFormat"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"grammar": "#/components/schemas/GrammarResponseFormat",
|
|
"json_schema": "#/components/schemas/JsonSchemaResponseFormat"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"model",
|
|
"instructions"
|
|
],
|
|
"title": "AgentConfig",
|
|
"description": "Configuration for an agent."
|
|
},
|
|
"AgentCreateResponse": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"agent_id"
|
|
],
|
|
"title": "AgentCreateResponse",
|
|
"description": "Response returned when creating a new agent."
|
|
},
|
|
"AgentSessionCreateResponse": {
|
|
"properties": {
|
|
"session_id": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"session_id"
|
|
],
|
|
"title": "AgentSessionCreateResponse",
|
|
"description": "Response returned when creating a new agent session."
|
|
},
|
|
"AgentToolGroupWithArgs": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"args": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Args"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"args"
|
|
],
|
|
"title": "AgentToolGroupWithArgs"
|
|
},
|
|
"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."
|
|
},
|
|
"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": {
|
|
"title": "Tool Names",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "AllowedToolsFilter",
|
|
"description": "Filter configuration for restricting which MCP tools can be used."
|
|
},
|
|
"ApprovalFilter": {
|
|
"properties": {
|
|
"always": {
|
|
"title": "Always",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"never": {
|
|
"title": "Never",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ApprovalFilter",
|
|
"description": "Filter configuration for MCP tool approval requirements."
|
|
},
|
|
"ArrayType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "array",
|
|
"title": "Type",
|
|
"default": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ArrayType",
|
|
"description": "Parameter type for array values."
|
|
},
|
|
"Attachment-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"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"mime_type": {
|
|
"type": "string",
|
|
"title": "Mime Type"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"mime_type"
|
|
],
|
|
"title": "Attachment",
|
|
"description": "An attachment to an agent turn."
|
|
},
|
|
"Attachment-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"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"mime_type": {
|
|
"type": "string",
|
|
"title": "Mime Type"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"mime_type"
|
|
],
|
|
"title": "Attachment",
|
|
"description": "An attachment to an agent turn."
|
|
},
|
|
"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": {
|
|
"title": "Cancelled At",
|
|
"type": "integer"
|
|
},
|
|
"cancelling_at": {
|
|
"title": "Cancelling At",
|
|
"type": "integer"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "integer"
|
|
},
|
|
"error_file_id": {
|
|
"title": "Error File Id",
|
|
"type": "string"
|
|
},
|
|
"errors": {
|
|
"$ref": "#/components/schemas/Errors"
|
|
},
|
|
"expired_at": {
|
|
"title": "Expired At",
|
|
"type": "integer"
|
|
},
|
|
"expires_at": {
|
|
"title": "Expires At",
|
|
"type": "integer"
|
|
},
|
|
"failed_at": {
|
|
"title": "Failed At",
|
|
"type": "integer"
|
|
},
|
|
"finalizing_at": {
|
|
"title": "Finalizing At",
|
|
"type": "integer"
|
|
},
|
|
"in_progress_at": {
|
|
"title": "In Progress At",
|
|
"type": "integer"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string"
|
|
},
|
|
"output_file_id": {
|
|
"title": "Output File Id",
|
|
"type": "string"
|
|
},
|
|
"request_counts": {
|
|
"$ref": "#/components/schemas/BatchRequestCounts"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/components/schemas/BatchUsage"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"completion_window",
|
|
"created_at",
|
|
"endpoint",
|
|
"input_file_id",
|
|
"object",
|
|
"status"
|
|
],
|
|
"title": "Batch"
|
|
},
|
|
"BatchError": {
|
|
"properties": {
|
|
"code": {
|
|
"title": "Code",
|
|
"type": "string"
|
|
},
|
|
"line": {
|
|
"title": "Line",
|
|
"type": "integer"
|
|
},
|
|
"message": {
|
|
"title": "Message",
|
|
"type": "string"
|
|
},
|
|
"param": {
|
|
"title": "Param",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "BatchError"
|
|
},
|
|
"BatchRequestCounts": {
|
|
"properties": {
|
|
"completed": {
|
|
"type": "integer",
|
|
"title": "Completed"
|
|
},
|
|
"failed": {
|
|
"type": "integer",
|
|
"title": "Failed"
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"title": "Total"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"completed",
|
|
"failed",
|
|
"total"
|
|
],
|
|
"title": "BatchRequestCounts"
|
|
},
|
|
"BatchUsage": {
|
|
"properties": {
|
|
"input_tokens": {
|
|
"type": "integer",
|
|
"title": "Input Tokens"
|
|
},
|
|
"input_tokens_details": {
|
|
"$ref": "#/components/schemas/InputTokensDetails"
|
|
},
|
|
"output_tokens": {
|
|
"type": "integer",
|
|
"title": "Output Tokens"
|
|
},
|
|
"output_tokens_details": {
|
|
"$ref": "#/components/schemas/OutputTokensDetails"
|
|
},
|
|
"total_tokens": {
|
|
"type": "integer",
|
|
"title": "Total Tokens"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"input_tokens",
|
|
"input_tokens_details",
|
|
"output_tokens",
|
|
"output_tokens_details",
|
|
"total_tokens"
|
|
],
|
|
"title": "BatchUsage"
|
|
},
|
|
"Benchmark": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id",
|
|
"description": "ID of the provider that owns this resource"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "benchmark",
|
|
"title": "Type",
|
|
"default": "benchmark"
|
|
},
|
|
"dataset_id": {
|
|
"type": "string",
|
|
"title": "Dataset Id"
|
|
},
|
|
"scoring_functions": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Scoring Functions"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Metadata",
|
|
"description": "Metadata for this evaluation task"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"identifier",
|
|
"provider_id",
|
|
"dataset_id",
|
|
"scoring_functions"
|
|
],
|
|
"title": "Benchmark",
|
|
"description": "A benchmark resource for evaluating model performance."
|
|
},
|
|
"BenchmarkConfig": {
|
|
"properties": {
|
|
"eval_candidate": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ModelCandidate"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentCandidate"
|
|
}
|
|
],
|
|
"title": "Eval Candidate",
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"agent": "#/components/schemas/AgentCandidate",
|
|
"model": "#/components/schemas/ModelCandidate"
|
|
}
|
|
}
|
|
},
|
|
"scoring_params": {
|
|
"additionalProperties": {
|
|
"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": "object",
|
|
"title": "Scoring Params",
|
|
"description": "Map between scoring function id and parameters for each scoring function you want to run"
|
|
},
|
|
"num_examples": {
|
|
"title": "Num Examples",
|
|
"description": "Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"eval_candidate"
|
|
],
|
|
"title": "BenchmarkConfig",
|
|
"description": "A benchmark configuration for evaluation."
|
|
},
|
|
"BooleanType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "boolean",
|
|
"title": "Type",
|
|
"default": "boolean"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "BooleanType",
|
|
"description": "Parameter type for boolean values."
|
|
},
|
|
"BuiltinTool": {
|
|
"type": "string",
|
|
"enum": [
|
|
"brave_search",
|
|
"wolfram_alpha",
|
|
"photogen",
|
|
"code_interpreter"
|
|
],
|
|
"title": "BuiltinTool"
|
|
},
|
|
"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."
|
|
},
|
|
"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": {
|
|
"title": "Embedding",
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"chunk_metadata": {
|
|
"$ref": "#/components/schemas/ChunkMetadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"chunk_id"
|
|
],
|
|
"title": "Chunk",
|
|
"description": "A chunk of content that can be inserted into a vector database."
|
|
},
|
|
"Chunk-Output": {
|
|
"properties": {
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem-Output"
|
|
},
|
|
{
|
|
"$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": {
|
|
"title": "Embedding",
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"chunk_metadata": {
|
|
"$ref": "#/components/schemas/ChunkMetadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"chunk_id"
|
|
],
|
|
"title": "Chunk",
|
|
"description": "A chunk of content that can be inserted into a vector database."
|
|
},
|
|
"ChunkMetadata": {
|
|
"properties": {
|
|
"chunk_id": {
|
|
"title": "Chunk Id",
|
|
"type": "string"
|
|
},
|
|
"document_id": {
|
|
"title": "Document Id",
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"title": "Source",
|
|
"type": "string"
|
|
},
|
|
"created_timestamp": {
|
|
"title": "Created Timestamp",
|
|
"type": "integer"
|
|
},
|
|
"updated_timestamp": {
|
|
"title": "Updated Timestamp",
|
|
"type": "integer"
|
|
},
|
|
"chunk_window": {
|
|
"title": "Chunk Window",
|
|
"type": "string"
|
|
},
|
|
"chunk_tokenizer": {
|
|
"title": "Chunk Tokenizer",
|
|
"type": "string"
|
|
},
|
|
"chunk_embedding_model": {
|
|
"title": "Chunk Embedding Model",
|
|
"type": "string"
|
|
},
|
|
"chunk_embedding_dimension": {
|
|
"title": "Chunk Embedding Dimension",
|
|
"type": "integer"
|
|
},
|
|
"content_token_count": {
|
|
"title": "Content Token Count",
|
|
"type": "integer"
|
|
},
|
|
"metadata_token_count": {
|
|
"title": "Metadata Token Count",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"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."
|
|
},
|
|
"CompletionMessage-Input": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "assistant",
|
|
"title": "Role",
|
|
"default": "assistant"
|
|
},
|
|
"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"
|
|
},
|
|
"stop_reason": {
|
|
"$ref": "#/components/schemas/StopReason"
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"stop_reason"
|
|
],
|
|
"title": "CompletionMessage",
|
|
"description": "A message containing the model's (assistant) response in a chat conversation."
|
|
},
|
|
"CompletionMessage-Output": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "assistant",
|
|
"title": "Role",
|
|
"default": "assistant"
|
|
},
|
|
"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"
|
|
},
|
|
"stop_reason": {
|
|
"$ref": "#/components/schemas/StopReason"
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"stop_reason"
|
|
],
|
|
"title": "CompletionMessage",
|
|
"description": "A message containing the model's (assistant) response in a chat conversation."
|
|
},
|
|
"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": {
|
|
"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.",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"items": {
|
|
"title": "Items",
|
|
"description": "Initial items to include in the conversation context. You may add up to 20 items at a time.",
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"created_at"
|
|
],
|
|
"title": "Conversation",
|
|
"description": "OpenAI-compatible conversation object."
|
|
},
|
|
"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": {
|
|
"title": "First Id",
|
|
"description": "The ID of the first item in the list",
|
|
"type": "string"
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"description": "The ID of the last item in the list",
|
|
"type": "string"
|
|
},
|
|
"has_more": {
|
|
"type": "boolean",
|
|
"title": "Has More",
|
|
"description": "Whether there are more items available",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ConversationItemList",
|
|
"description": "List of conversation items with pagination."
|
|
},
|
|
"DPOAlignmentConfig": {
|
|
"properties": {
|
|
"beta": {
|
|
"type": "number",
|
|
"title": "Beta"
|
|
},
|
|
"loss_type": {
|
|
"$ref": "#/components/schemas/DPOLossType",
|
|
"default": "sigmoid"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"beta"
|
|
],
|
|
"title": "DPOAlignmentConfig",
|
|
"description": "Configuration for Direct Preference Optimization (DPO) alignment."
|
|
},
|
|
"DPOLossType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"sigmoid",
|
|
"hinge",
|
|
"ipo",
|
|
"kto_pair"
|
|
],
|
|
"title": "DPOLossType"
|
|
},
|
|
"DataConfig": {
|
|
"properties": {
|
|
"dataset_id": {
|
|
"type": "string",
|
|
"title": "Dataset Id"
|
|
},
|
|
"batch_size": {
|
|
"type": "integer",
|
|
"title": "Batch Size"
|
|
},
|
|
"shuffle": {
|
|
"type": "boolean",
|
|
"title": "Shuffle"
|
|
},
|
|
"data_format": {
|
|
"$ref": "#/components/schemas/DatasetFormat"
|
|
},
|
|
"validation_dataset_id": {
|
|
"title": "Validation Dataset Id",
|
|
"type": "string"
|
|
},
|
|
"packed": {
|
|
"title": "Packed",
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"train_on_input": {
|
|
"title": "Train On Input",
|
|
"default": false,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"dataset_id",
|
|
"batch_size",
|
|
"shuffle",
|
|
"data_format"
|
|
],
|
|
"title": "DataConfig",
|
|
"description": "Configuration for training data and data loading."
|
|
},
|
|
"Dataset": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id",
|
|
"description": "ID of the provider that owns this resource"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "dataset",
|
|
"title": "Type",
|
|
"default": "dataset"
|
|
},
|
|
"purpose": {
|
|
"$ref": "#/components/schemas/DatasetPurpose"
|
|
},
|
|
"source": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/URIDataSource"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/RowsDataSource"
|
|
}
|
|
],
|
|
"title": "Source",
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"rows": "#/components/schemas/RowsDataSource",
|
|
"uri": "#/components/schemas/URIDataSource"
|
|
}
|
|
}
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Metadata",
|
|
"description": "Any additional metadata for this dataset"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"identifier",
|
|
"provider_id",
|
|
"purpose",
|
|
"source"
|
|
],
|
|
"title": "Dataset",
|
|
"description": "Dataset resource for storing and accessing training or evaluation data."
|
|
},
|
|
"DatasetFormat": {
|
|
"type": "string",
|
|
"enum": [
|
|
"instruct",
|
|
"dialog"
|
|
],
|
|
"title": "DatasetFormat",
|
|
"description": "Format of the training dataset."
|
|
},
|
|
"DatasetPurpose": {
|
|
"type": "string",
|
|
"enum": [
|
|
"post-training/messages",
|
|
"eval/question-answer",
|
|
"eval/messages-answer"
|
|
],
|
|
"title": "DatasetPurpose",
|
|
"description": "Purpose of the dataset. Each purpose has a required input data schema."
|
|
},
|
|
"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."
|
|
},
|
|
"Document": {
|
|
"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"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"mime_type": {
|
|
"type": "string",
|
|
"title": "Mime Type"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"mime_type"
|
|
],
|
|
"title": "Document",
|
|
"description": "A document to be used by an agent."
|
|
},
|
|
"EfficiencyConfig": {
|
|
"properties": {
|
|
"enable_activation_checkpointing": {
|
|
"title": "Enable Activation Checkpointing",
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"enable_activation_offloading": {
|
|
"title": "Enable Activation Offloading",
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"memory_efficient_fsdp_wrap": {
|
|
"title": "Memory Efficient Fsdp Wrap",
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"fsdp_cpu_offload": {
|
|
"title": "Fsdp Cpu Offload",
|
|
"default": false,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "EfficiencyConfig",
|
|
"description": "Configuration for memory and compute efficiency optimizations."
|
|
},
|
|
"Errors": {
|
|
"properties": {
|
|
"data": {
|
|
"title": "Data",
|
|
"items": {
|
|
"$ref": "#/components/schemas/BatchError"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"object": {
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Errors"
|
|
},
|
|
"EvaluateResponse": {
|
|
"properties": {
|
|
"generations": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array",
|
|
"title": "Generations"
|
|
},
|
|
"scores": {
|
|
"additionalProperties": {
|
|
"$ref": "#/components/schemas/ScoringResult"
|
|
},
|
|
"type": "object",
|
|
"title": "Scores"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"generations",
|
|
"scores"
|
|
],
|
|
"title": "EvaluateResponse",
|
|
"description": "The response from an evaluation."
|
|
},
|
|
"GrammarResponseFormat": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "grammar",
|
|
"title": "Type",
|
|
"default": "grammar"
|
|
},
|
|
"bnf": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Bnf"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"bnf"
|
|
],
|
|
"title": "GrammarResponseFormat",
|
|
"description": "Configuration for grammar-guided response generation."
|
|
},
|
|
"GreedySamplingStrategy": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "greedy",
|
|
"title": "Type",
|
|
"default": "greedy"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "GreedySamplingStrategy",
|
|
"description": "Greedy sampling strategy that selects the highest probability token at each step."
|
|
},
|
|
"HealthInfo": {
|
|
"properties": {
|
|
"status": {
|
|
"$ref": "#/components/schemas/HealthStatus"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"status"
|
|
],
|
|
"title": "HealthInfo",
|
|
"description": "Health status information for the service."
|
|
},
|
|
"HealthStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OK",
|
|
"Error",
|
|
"Not Implemented"
|
|
],
|
|
"title": "HealthStatus"
|
|
},
|
|
"ImageContentItem-Input": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "image",
|
|
"title": "Type",
|
|
"default": "image"
|
|
},
|
|
"image": {
|
|
"$ref": "#/components/schemas/_URLOrData"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"image"
|
|
],
|
|
"title": "ImageContentItem",
|
|
"description": "A image content item"
|
|
},
|
|
"ImageContentItem-Output": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "image",
|
|
"title": "Type",
|
|
"default": "image"
|
|
},
|
|
"image": {
|
|
"$ref": "#/components/schemas/_URLOrData"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"image"
|
|
],
|
|
"title": "ImageContentItem",
|
|
"description": "A image content item"
|
|
},
|
|
"InferenceStep-Input": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "inference",
|
|
"title": "Step Type",
|
|
"default": "inference"
|
|
},
|
|
"model_response": {
|
|
"$ref": "#/components/schemas/CompletionMessage-Input"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"model_response"
|
|
],
|
|
"title": "InferenceStep",
|
|
"description": "An inference step in an agent turn."
|
|
},
|
|
"InferenceStep-Output": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "inference",
|
|
"title": "Step Type",
|
|
"default": "inference"
|
|
},
|
|
"model_response": {
|
|
"$ref": "#/components/schemas/CompletionMessage-Output"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"model_response"
|
|
],
|
|
"title": "InferenceStep",
|
|
"description": "An inference step in an agent turn."
|
|
},
|
|
"InputTokensDetails": {
|
|
"properties": {
|
|
"cached_tokens": {
|
|
"type": "integer",
|
|
"title": "Cached Tokens"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"cached_tokens"
|
|
],
|
|
"title": "InputTokensDetails"
|
|
},
|
|
"Job": {
|
|
"properties": {
|
|
"job_id": {
|
|
"type": "string",
|
|
"title": "Job Id"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/JobStatus"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"job_id",
|
|
"status"
|
|
],
|
|
"title": "Job",
|
|
"description": "A job execution instance with status tracking."
|
|
},
|
|
"JobStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"completed",
|
|
"in_progress",
|
|
"failed",
|
|
"scheduled",
|
|
"cancelled"
|
|
],
|
|
"title": "JobStatus",
|
|
"description": "Status of a job execution."
|
|
},
|
|
"JsonSchemaResponseFormat": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "json_schema",
|
|
"title": "Type",
|
|
"default": "json_schema"
|
|
},
|
|
"json_schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Json Schema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"json_schema"
|
|
],
|
|
"title": "JsonSchemaResponseFormat",
|
|
"description": "Configuration for JSON schema-guided response generation."
|
|
},
|
|
"JsonType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "json",
|
|
"title": "Type",
|
|
"default": "json"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "JsonType",
|
|
"description": "Parameter type for JSON values."
|
|
},
|
|
"LLMAsJudgeScoringFnParams": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "llm_as_judge",
|
|
"title": "Type",
|
|
"default": "llm_as_judge"
|
|
},
|
|
"judge_model": {
|
|
"type": "string",
|
|
"title": "Judge Model"
|
|
},
|
|
"prompt_template": {
|
|
"title": "Prompt Template",
|
|
"type": "string"
|
|
},
|
|
"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."
|
|
},
|
|
"ListBenchmarksResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Benchmark"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListBenchmarksResponse"
|
|
},
|
|
"ListDatasetsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListDatasetsResponse",
|
|
"description": "Response from listing datasets."
|
|
},
|
|
"ListModelsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Model"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListModelsResponse"
|
|
},
|
|
"ListPostTrainingJobsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/PostTrainingJob"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListPostTrainingJobsResponse"
|
|
},
|
|
"ListPromptsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Prompt"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListPromptsResponse",
|
|
"description": "Response model to list prompts."
|
|
},
|
|
"ListProvidersResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ProviderInfo"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListProvidersResponse",
|
|
"description": "Response containing a list of all available providers."
|
|
},
|
|
"ListRoutesResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/RouteInfo"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListRoutesResponse",
|
|
"description": "Response containing a list of all available API routes."
|
|
},
|
|
"ListScoringFunctionsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ScoringFn-Output"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListScoringFunctionsResponse"
|
|
},
|
|
"ListShieldsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Shield"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListShieldsResponse"
|
|
},
|
|
"ListToolGroupsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolGroup"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListToolGroupsResponse",
|
|
"description": "Response containing a list of tool groups."
|
|
},
|
|
"MCPListToolsTool": {
|
|
"properties": {
|
|
"input_schema": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Input Schema"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input_schema",
|
|
"name"
|
|
],
|
|
"title": "MCPListToolsTool",
|
|
"description": "Tool definition returned by MCP list tools operation."
|
|
},
|
|
"MemoryRetrievalStep-Input": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "memory_retrieval",
|
|
"title": "Step Type",
|
|
"default": "memory_retrieval"
|
|
},
|
|
"vector_store_ids": {
|
|
"type": "string",
|
|
"title": "Vector Store Ids"
|
|
},
|
|
"inserted_context": {
|
|
"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": "Inserted Context"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"vector_store_ids",
|
|
"inserted_context"
|
|
],
|
|
"title": "MemoryRetrievalStep",
|
|
"description": "A memory retrieval step in an agent turn."
|
|
},
|
|
"MemoryRetrievalStep-Output": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "memory_retrieval",
|
|
"title": "Step Type",
|
|
"default": "memory_retrieval"
|
|
},
|
|
"vector_store_ids": {
|
|
"type": "string",
|
|
"title": "Vector Store Ids"
|
|
},
|
|
"inserted_context": {
|
|
"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": "Inserted Context"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"vector_store_ids",
|
|
"inserted_context"
|
|
],
|
|
"title": "MemoryRetrievalStep",
|
|
"description": "A memory retrieval step in an agent turn."
|
|
},
|
|
"Model": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id",
|
|
"description": "ID of the provider that owns this resource"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "model",
|
|
"title": "Type",
|
|
"default": "model"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Metadata",
|
|
"description": "Any additional metadata for this model"
|
|
},
|
|
"model_type": {
|
|
"$ref": "#/components/schemas/ModelType",
|
|
"default": "llm"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"identifier",
|
|
"provider_id"
|
|
],
|
|
"title": "Model",
|
|
"description": "A model resource representing an AI model registered in Llama Stack."
|
|
},
|
|
"ModelCandidate": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "model",
|
|
"title": "Type",
|
|
"default": "model"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"sampling_params": {
|
|
"$ref": "#/components/schemas/SamplingParams"
|
|
},
|
|
"system_message": {
|
|
"$ref": "#/components/schemas/SystemMessage"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"model",
|
|
"sampling_params"
|
|
],
|
|
"title": "ModelCandidate",
|
|
"description": "A model candidate for evaluation."
|
|
},
|
|
"ModelType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llm",
|
|
"embedding",
|
|
"rerank"
|
|
],
|
|
"title": "ModelType",
|
|
"description": "Enumeration of supported model types in Llama Stack."
|
|
},
|
|
"ModerationObject": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"results": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ModerationObjectResults"
|
|
},
|
|
"type": "array",
|
|
"title": "Results"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"model",
|
|
"results"
|
|
],
|
|
"title": "ModerationObject",
|
|
"description": "A moderation object."
|
|
},
|
|
"ModerationObjectResults": {
|
|
"properties": {
|
|
"flagged": {
|
|
"type": "boolean",
|
|
"title": "Flagged"
|
|
},
|
|
"categories": {
|
|
"title": "Categories",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"category_applied_input_types": {
|
|
"title": "Category Applied Input Types",
|
|
"additionalProperties": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"category_scores": {
|
|
"title": "Category Scores",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"user_message": {
|
|
"title": "User Message",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"flagged"
|
|
],
|
|
"title": "ModerationObjectResults",
|
|
"description": "A moderation object."
|
|
},
|
|
"NumberType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "number",
|
|
"title": "Type",
|
|
"default": "number"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "NumberType",
|
|
"description": "Parameter type for numeric values."
|
|
},
|
|
"ObjectType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "object",
|
|
"title": "Type",
|
|
"default": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ObjectType",
|
|
"description": "Parameter type for object values."
|
|
},
|
|
"OpenAIAssistantMessageParam-Input": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "assistant",
|
|
"title": "Role",
|
|
"default": "assistant"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionContentPartTextParam"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionToolCall"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIAssistantMessageParam",
|
|
"description": "A message containing the model's (assistant) response in an OpenAI-compatible chat completion request."
|
|
},
|
|
"OpenAIAssistantMessageParam-Output": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "assistant",
|
|
"title": "Role",
|
|
"default": "assistant"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionContentPartTextParam"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionToolCall"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIAssistantMessageParam",
|
|
"description": "A message containing the model's (assistant) response in an OpenAI-compatible chat completion request."
|
|
},
|
|
"OpenAIChatCompletion": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"choices": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChoice-Output"
|
|
},
|
|
"type": "array",
|
|
"title": "Choices"
|
|
},
|
|
"object": {
|
|
"type": "string",
|
|
"const": "chat.completion",
|
|
"title": "Object",
|
|
"default": "chat.completion"
|
|
},
|
|
"created": {
|
|
"type": "integer",
|
|
"title": "Created"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionUsage"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"choices",
|
|
"created",
|
|
"model"
|
|
],
|
|
"title": "OpenAIChatCompletion",
|
|
"description": "Response from an OpenAI-compatible chat completion request."
|
|
},
|
|
"OpenAIChatCompletionContentPartImageParam": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "image_url",
|
|
"title": "Type",
|
|
"default": "image_url"
|
|
},
|
|
"image_url": {
|
|
"$ref": "#/components/schemas/OpenAIImageURL"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"image_url"
|
|
],
|
|
"title": "OpenAIChatCompletionContentPartImageParam",
|
|
"description": "Image content part for OpenAI-compatible chat completion messages."
|
|
},
|
|
"OpenAIChatCompletionContentPartTextParam": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "text",
|
|
"title": "Type",
|
|
"default": "text"
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"title": "Text"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "OpenAIChatCompletionContentPartTextParam",
|
|
"description": "Text content part for OpenAI-compatible chat completion messages."
|
|
},
|
|
"OpenAIChatCompletionRequestWithExtraBody": {
|
|
"properties": {
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"messages": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIUserMessageParam-Input"
|
|
},
|
|
{
|
|
"$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": {
|
|
"title": "Frequency Penalty",
|
|
"type": "number"
|
|
},
|
|
"function_call": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
],
|
|
"title": "Function Call"
|
|
},
|
|
"functions": {
|
|
"title": "Functions",
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"logit_bias": {
|
|
"title": "Logit Bias",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"type": "boolean"
|
|
},
|
|
"max_completion_tokens": {
|
|
"title": "Max Completion Tokens",
|
|
"type": "integer"
|
|
},
|
|
"max_tokens": {
|
|
"title": "Max Tokens",
|
|
"type": "integer"
|
|
},
|
|
"n": {
|
|
"title": "N",
|
|
"type": "integer"
|
|
},
|
|
"parallel_tool_calls": {
|
|
"title": "Parallel Tool Calls",
|
|
"type": "boolean"
|
|
},
|
|
"presence_penalty": {
|
|
"title": "Presence Penalty",
|
|
"type": "number"
|
|
},
|
|
"response_format": {
|
|
"title": "Response Format",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"seed": {
|
|
"title": "Seed",
|
|
"type": "integer"
|
|
},
|
|
"stop": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Stop"
|
|
},
|
|
"stream": {
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
},
|
|
"stream_options": {
|
|
"title": "Stream Options",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"temperature": {
|
|
"title": "Temperature",
|
|
"type": "number"
|
|
},
|
|
"tool_choice": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
],
|
|
"title": "Tool Choice"
|
|
},
|
|
"tools": {
|
|
"title": "Tools",
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"top_logprobs": {
|
|
"title": "Top Logprobs",
|
|
"type": "integer"
|
|
},
|
|
"top_p": {
|
|
"title": "Top P",
|
|
"type": "number"
|
|
},
|
|
"user": {
|
|
"title": "User",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"model",
|
|
"messages"
|
|
],
|
|
"title": "OpenAIChatCompletionRequestWithExtraBody",
|
|
"description": "Request parameters for OpenAI-compatible chat completion endpoint."
|
|
},
|
|
"OpenAIChatCompletionToolCall": {
|
|
"properties": {
|
|
"index": {
|
|
"title": "Index",
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "function",
|
|
"title": "Type",
|
|
"default": "function"
|
|
},
|
|
"function": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionToolCallFunction"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIChatCompletionToolCall",
|
|
"description": "Tool call specification for OpenAI-compatible chat completion responses."
|
|
},
|
|
"OpenAIChatCompletionToolCallFunction": {
|
|
"properties": {
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"title": "Arguments",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails"
|
|
},
|
|
"completion_tokens_details": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt_tokens",
|
|
"completion_tokens",
|
|
"total_tokens"
|
|
],
|
|
"title": "OpenAIChatCompletionUsage",
|
|
"description": "Usage information for OpenAI chat completion."
|
|
},
|
|
"OpenAIChatCompletionUsageCompletionTokensDetails": {
|
|
"properties": {
|
|
"reasoning_tokens": {
|
|
"title": "Reasoning Tokens",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIChatCompletionUsageCompletionTokensDetails",
|
|
"description": "Token details for output tokens in OpenAI chat completion usage."
|
|
},
|
|
"OpenAIChatCompletionUsagePromptTokensDetails": {
|
|
"properties": {
|
|
"cached_tokens": {
|
|
"title": "Cached Tokens",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIChatCompletionUsagePromptTokensDetails",
|
|
"description": "Token details for prompt tokens in OpenAI chat completion usage."
|
|
},
|
|
"OpenAIChoice-Input": {
|
|
"properties": {
|
|
"message": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIUserMessageParam-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAISystemMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIAssistantMessageParam-Input"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIToolMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIDeveloperMessageParam"
|
|
}
|
|
],
|
|
"title": "Message",
|
|
"discriminator": {
|
|
"propertyName": "role",
|
|
"mapping": {
|
|
"assistant": "#/components/schemas/OpenAIAssistantMessageParam-Input",
|
|
"developer": "#/components/schemas/OpenAIDeveloperMessageParam",
|
|
"system": "#/components/schemas/OpenAISystemMessageParam",
|
|
"tool": "#/components/schemas/OpenAIToolMessageParam",
|
|
"user": "#/components/schemas/OpenAIUserMessageParam-Input"
|
|
}
|
|
}
|
|
},
|
|
"finish_reason": {
|
|
"type": "string",
|
|
"title": "Finish Reason"
|
|
},
|
|
"index": {
|
|
"type": "integer",
|
|
"title": "Index"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs-Input"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"message",
|
|
"finish_reason",
|
|
"index"
|
|
],
|
|
"title": "OpenAIChoice",
|
|
"description": "A choice from an OpenAI-compatible chat completion response."
|
|
},
|
|
"OpenAIChoice-Output": {
|
|
"properties": {
|
|
"message": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIUserMessageParam-Output"
|
|
},
|
|
{
|
|
"$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": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs-Output"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"message",
|
|
"finish_reason",
|
|
"index"
|
|
],
|
|
"title": "OpenAIChoice",
|
|
"description": "A choice from an OpenAI-compatible chat completion response."
|
|
},
|
|
"OpenAIChoiceLogprobs-Input": {
|
|
"properties": {
|
|
"content": {
|
|
"title": "Content",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAITokenLogProb"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"refusal": {
|
|
"title": "Refusal",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAITokenLogProb"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIChoiceLogprobs",
|
|
"description": "The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response."
|
|
},
|
|
"OpenAIChoiceLogprobs-Output": {
|
|
"properties": {
|
|
"content": {
|
|
"title": "Content",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAITokenLogProb"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"refusal": {
|
|
"title": "Refusal",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAITokenLogProb"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"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."
|
|
},
|
|
"OpenAICompletionChoice-Input": {
|
|
"properties": {
|
|
"finish_reason": {
|
|
"type": "string",
|
|
"title": "Finish Reason"
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"title": "Text"
|
|
},
|
|
"index": {
|
|
"type": "integer",
|
|
"title": "Index"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs-Input"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"finish_reason",
|
|
"text",
|
|
"index"
|
|
],
|
|
"title": "OpenAICompletionChoice",
|
|
"description": "A choice from an OpenAI-compatible completion response."
|
|
},
|
|
"OpenAICompletionChoice-Output": {
|
|
"properties": {
|
|
"finish_reason": {
|
|
"type": "string",
|
|
"title": "Finish Reason"
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"title": "Text"
|
|
},
|
|
"index": {
|
|
"type": "integer",
|
|
"title": "Index"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs-Output"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"finish_reason",
|
|
"text",
|
|
"index"
|
|
],
|
|
"title": "OpenAICompletionChoice",
|
|
"description": "A choice from an OpenAI-compatible completion response."
|
|
},
|
|
"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": {
|
|
"title": "Best Of",
|
|
"type": "integer"
|
|
},
|
|
"echo": {
|
|
"title": "Echo",
|
|
"type": "boolean"
|
|
},
|
|
"frequency_penalty": {
|
|
"title": "Frequency Penalty",
|
|
"type": "number"
|
|
},
|
|
"logit_bias": {
|
|
"title": "Logit Bias",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"type": "boolean"
|
|
},
|
|
"max_tokens": {
|
|
"title": "Max Tokens",
|
|
"type": "integer"
|
|
},
|
|
"n": {
|
|
"title": "N",
|
|
"type": "integer"
|
|
},
|
|
"presence_penalty": {
|
|
"title": "Presence Penalty",
|
|
"type": "number"
|
|
},
|
|
"seed": {
|
|
"title": "Seed",
|
|
"type": "integer"
|
|
},
|
|
"stop": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Stop"
|
|
},
|
|
"stream": {
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
},
|
|
"stream_options": {
|
|
"title": "Stream Options",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"temperature": {
|
|
"title": "Temperature",
|
|
"type": "number"
|
|
},
|
|
"top_p": {
|
|
"title": "Top P",
|
|
"type": "number"
|
|
},
|
|
"user": {
|
|
"title": "User",
|
|
"type": "string"
|
|
},
|
|
"suffix": {
|
|
"title": "Suffix",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"model",
|
|
"prompt"
|
|
],
|
|
"title": "OpenAICompletionRequestWithExtraBody",
|
|
"description": "Request parameters for OpenAI-compatible completion endpoint."
|
|
},
|
|
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody": {
|
|
"properties": {
|
|
"file_ids": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "File Ids"
|
|
},
|
|
"attributes": {
|
|
"title": "Attributes",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"chunking_strategy": {
|
|
"title": "Chunking Strategy",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VectorStoreChunkingStrategyAuto"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VectorStoreChunkingStrategyStatic"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"auto": "#/components/schemas/VectorStoreChunkingStrategyAuto",
|
|
"static": "#/components/schemas/VectorStoreChunkingStrategyStatic"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"file_ids": {
|
|
"title": "File Ids",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"expires_after": {
|
|
"title": "Expires After",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"chunking_strategy": {
|
|
"title": "Chunking Strategy",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "OpenAICreateVectorStoreRequestWithExtraBody",
|
|
"description": "Request to create a vector store with extra_body support."
|
|
},
|
|
"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": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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": {
|
|
"title": "Encoding Format",
|
|
"default": "float",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"title": "Dimensions",
|
|
"type": "integer"
|
|
},
|
|
"user": {
|
|
"title": "User",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"OpenAIFileFile": {
|
|
"properties": {
|
|
"file_data": {
|
|
"title": "File Data",
|
|
"type": "string"
|
|
},
|
|
"file_id": {
|
|
"title": "File Id",
|
|
"type": "string"
|
|
},
|
|
"filename": {
|
|
"title": "Filename",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIFileFile"
|
|
},
|
|
"OpenAIFileObject": {
|
|
"properties": {
|
|
"object": {
|
|
"type": "string",
|
|
"const": "file",
|
|
"title": "Object",
|
|
"default": "file"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"bytes": {
|
|
"type": "integer",
|
|
"title": "Bytes"
|
|
},
|
|
"created_at": {
|
|
"type": "integer",
|
|
"title": "Created At"
|
|
},
|
|
"expires_at": {
|
|
"type": "integer",
|
|
"title": "Expires At"
|
|
},
|
|
"filename": {
|
|
"type": "string",
|
|
"title": "Filename"
|
|
},
|
|
"purpose": {
|
|
"$ref": "#/components/schemas/OpenAIFilePurpose"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"bytes",
|
|
"created_at",
|
|
"expires_at",
|
|
"filename",
|
|
"purpose"
|
|
],
|
|
"title": "OpenAIFileObject",
|
|
"description": "OpenAI File object as defined in the OpenAI Files API."
|
|
},
|
|
"OpenAIFilePurpose": {
|
|
"type": "string",
|
|
"enum": [
|
|
"assistants",
|
|
"batch"
|
|
],
|
|
"title": "OpenAIFilePurpose",
|
|
"description": "Valid purpose values for OpenAI Files API."
|
|
},
|
|
"OpenAIImageURL": {
|
|
"properties": {
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Url"
|
|
},
|
|
"detail": {
|
|
"title": "Detail",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"url"
|
|
],
|
|
"title": "OpenAIImageURL",
|
|
"description": "Image URL specification for OpenAI-compatible chat completion messages."
|
|
},
|
|
"OpenAIJSONSchema": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"strict": {
|
|
"title": "Strict",
|
|
"type": "boolean"
|
|
},
|
|
"schema": {
|
|
"title": "Schema",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIJSONSchema",
|
|
"description": "JSON schema specification for OpenAI-compatible structured response format."
|
|
},
|
|
"OpenAIListModelsResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIModel"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "OpenAIListModelsResponse"
|
|
},
|
|
"OpenAIModel": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"object": {
|
|
"type": "string",
|
|
"const": "model",
|
|
"title": "Object",
|
|
"default": "model"
|
|
},
|
|
"created": {
|
|
"type": "integer",
|
|
"title": "Created"
|
|
},
|
|
"owned_by": {
|
|
"type": "string",
|
|
"title": "Owned By"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"owned_by"
|
|
],
|
|
"title": "OpenAIModel",
|
|
"description": "A model from OpenAI."
|
|
},
|
|
"OpenAIResponseAnnotationCitation": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "url_citation",
|
|
"title": "Type",
|
|
"default": "url_citation"
|
|
},
|
|
"end_index": {
|
|
"type": "integer",
|
|
"title": "End Index"
|
|
},
|
|
"start_index": {
|
|
"type": "integer",
|
|
"title": "Start Index"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"title": "Title"
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Url"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"end_index",
|
|
"start_index",
|
|
"title",
|
|
"url"
|
|
],
|
|
"title": "OpenAIResponseAnnotationCitation",
|
|
"description": "URL citation annotation for referencing external web resources."
|
|
},
|
|
"OpenAIResponseAnnotationContainerFileCitation": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "container_file_citation",
|
|
"title": "Type",
|
|
"default": "container_file_citation"
|
|
},
|
|
"container_id": {
|
|
"type": "string",
|
|
"title": "Container Id"
|
|
},
|
|
"end_index": {
|
|
"type": "integer",
|
|
"title": "End Index"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"filename": {
|
|
"type": "string",
|
|
"title": "Filename"
|
|
},
|
|
"start_index": {
|
|
"type": "integer",
|
|
"title": "Start Index"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"container_id",
|
|
"end_index",
|
|
"file_id",
|
|
"filename",
|
|
"start_index"
|
|
],
|
|
"title": "OpenAIResponseAnnotationContainerFileCitation"
|
|
},
|
|
"OpenAIResponseAnnotationFileCitation": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "file_citation",
|
|
"title": "Type",
|
|
"default": "file_citation"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"filename": {
|
|
"type": "string",
|
|
"title": "Filename"
|
|
},
|
|
"index": {
|
|
"type": "integer",
|
|
"title": "Index"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"file_id",
|
|
"filename",
|
|
"index"
|
|
],
|
|
"title": "OpenAIResponseAnnotationFileCitation",
|
|
"description": "File citation annotation for referencing specific files in response content."
|
|
},
|
|
"OpenAIResponseAnnotationFilePath": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "file_path",
|
|
"title": "Type",
|
|
"default": "file_path"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"index": {
|
|
"type": "integer",
|
|
"title": "Index"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"file_id",
|
|
"index"
|
|
],
|
|
"title": "OpenAIResponseAnnotationFilePath"
|
|
},
|
|
"OpenAIResponseContentPartRefusal": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "refusal",
|
|
"title": "Type",
|
|
"default": "refusal"
|
|
},
|
|
"refusal": {
|
|
"type": "string",
|
|
"title": "Refusal"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"refusal"
|
|
],
|
|
"title": "OpenAIResponseContentPartRefusal",
|
|
"description": "Refusal content within a streamed response part."
|
|
},
|
|
"OpenAIResponseError": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"title": "Code"
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"title": "Message"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"title": "OpenAIResponseError",
|
|
"description": "Error details for failed OpenAI response requests."
|
|
},
|
|
"OpenAIResponseFormatJSONObject": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "json_object",
|
|
"title": "Type",
|
|
"default": "json_object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseFormatJSONObject",
|
|
"description": "JSON object response format for OpenAI-compatible chat completion requests."
|
|
},
|
|
"OpenAIResponseFormatJSONSchema": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "json_schema",
|
|
"title": "Type",
|
|
"default": "json_schema"
|
|
},
|
|
"json_schema": {
|
|
"$ref": "#/components/schemas/OpenAIJSONSchema"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"json_schema"
|
|
],
|
|
"title": "OpenAIResponseFormatJSONSchema",
|
|
"description": "JSON schema response format for OpenAI-compatible chat completion requests."
|
|
},
|
|
"OpenAIResponseFormatText": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "text",
|
|
"title": "Type",
|
|
"default": "text"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseFormatText",
|
|
"description": "Text response format for OpenAI-compatible chat completion requests."
|
|
},
|
|
"OpenAIResponseInputFunctionToolCallOutput": {
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call Id"
|
|
},
|
|
"output": {
|
|
"type": "string",
|
|
"title": "Output"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "function_call_output",
|
|
"title": "Type",
|
|
"default": "function_call_output"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"output"
|
|
],
|
|
"title": "OpenAIResponseInputFunctionToolCallOutput",
|
|
"description": "This represents the output of a function call that gets passed back to the model."
|
|
},
|
|
"OpenAIResponseInputMessageContentFile": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "input_file",
|
|
"title": "Type",
|
|
"default": "input_file"
|
|
},
|
|
"file_data": {
|
|
"title": "File Data",
|
|
"type": "string"
|
|
},
|
|
"file_id": {
|
|
"title": "File Id",
|
|
"type": "string"
|
|
},
|
|
"file_url": {
|
|
"title": "File Url",
|
|
"type": "string"
|
|
},
|
|
"filename": {
|
|
"title": "Filename",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseInputMessageContentFile",
|
|
"description": "File content for input messages in OpenAI response format."
|
|
},
|
|
"OpenAIResponseInputMessageContentImage": {
|
|
"properties": {
|
|
"detail": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"const": "low"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"const": "high"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"const": "auto"
|
|
}
|
|
],
|
|
"title": "Detail",
|
|
"default": "auto"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "input_image",
|
|
"title": "Type",
|
|
"default": "input_image"
|
|
},
|
|
"file_id": {
|
|
"title": "File Id",
|
|
"type": "string"
|
|
},
|
|
"image_url": {
|
|
"title": "Image Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseInputMessageContentImage",
|
|
"description": "Image content for input messages in OpenAI response format."
|
|
},
|
|
"OpenAIResponseInputMessageContentText": {
|
|
"properties": {
|
|
"text": {
|
|
"type": "string",
|
|
"title": "Text"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "input_text",
|
|
"title": "Type",
|
|
"default": "input_text"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "OpenAIResponseInputMessageContentText",
|
|
"description": "Text content for input messages in OpenAI response format."
|
|
},
|
|
"OpenAIResponseInputToolFileSearch": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "file_search",
|
|
"title": "Type",
|
|
"default": "file_search"
|
|
},
|
|
"vector_store_ids": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Vector Store Ids"
|
|
},
|
|
"filters": {
|
|
"title": "Filters",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"max_num_results": {
|
|
"title": "Max Num Results",
|
|
"default": 10,
|
|
"type": "integer",
|
|
"maximum": 50.0,
|
|
"minimum": 1.0
|
|
},
|
|
"ranking_options": {
|
|
"$ref": "#/components/schemas/SearchRankingOptions"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_ids"
|
|
],
|
|
"title": "OpenAIResponseInputToolFileSearch",
|
|
"description": "File search tool configuration for OpenAI response inputs."
|
|
},
|
|
"OpenAIResponseInputToolFunction": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "function",
|
|
"title": "Type",
|
|
"default": "function"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"title": "Parameters",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"strict": {
|
|
"title": "Strict",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"parameters"
|
|
],
|
|
"title": "OpenAIResponseInputToolFunction",
|
|
"description": "Function tool configuration for OpenAI response inputs."
|
|
},
|
|
"OpenAIResponseInputToolMCP": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "mcp",
|
|
"title": "Type",
|
|
"default": "mcp"
|
|
},
|
|
"server_label": {
|
|
"type": "string",
|
|
"title": "Server Label"
|
|
},
|
|
"server_url": {
|
|
"type": "string",
|
|
"title": "Server Url"
|
|
},
|
|
"headers": {
|
|
"title": "Headers",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"require_approval": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"const": "always"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"const": "never"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ApprovalFilter"
|
|
}
|
|
],
|
|
"title": "Require Approval",
|
|
"default": "never"
|
|
},
|
|
"allowed_tools": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AllowedToolsFilter"
|
|
}
|
|
],
|
|
"title": "Allowed Tools"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"server_label",
|
|
"server_url"
|
|
],
|
|
"title": "OpenAIResponseInputToolMCP",
|
|
"description": "Model Context Protocol (MCP) tool configuration for OpenAI response inputs."
|
|
},
|
|
"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",
|
|
"default": "web_search"
|
|
},
|
|
"search_context_size": {
|
|
"title": "Search Context Size",
|
|
"default": "medium",
|
|
"type": "string",
|
|
"pattern": "^low|medium|high$"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseInputToolWebSearch",
|
|
"description": "Web search tool configuration for OpenAI response inputs."
|
|
},
|
|
"OpenAIResponseMCPApprovalRequest": {
|
|
"properties": {
|
|
"arguments": {
|
|
"type": "string",
|
|
"title": "Arguments"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"server_label": {
|
|
"type": "string",
|
|
"title": "Server Label"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "mcp_approval_request",
|
|
"title": "Type",
|
|
"default": "mcp_approval_request"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"arguments",
|
|
"id",
|
|
"name",
|
|
"server_label"
|
|
],
|
|
"title": "OpenAIResponseMCPApprovalRequest",
|
|
"description": "A request for human approval of a tool invocation."
|
|
},
|
|
"OpenAIResponseMCPApprovalResponse": {
|
|
"properties": {
|
|
"approval_request_id": {
|
|
"type": "string",
|
|
"title": "Approval Request Id"
|
|
},
|
|
"approve": {
|
|
"type": "boolean",
|
|
"title": "Approve"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "mcp_approval_response",
|
|
"title": "Type",
|
|
"default": "mcp_approval_response"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"reason": {
|
|
"title": "Reason",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"error": {
|
|
"$ref": "#/components/schemas/OpenAIResponseError"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"object": {
|
|
"type": "string",
|
|
"const": "response",
|
|
"title": "Object",
|
|
"default": "response"
|
|
},
|
|
"output": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage-Output"
|
|
},
|
|
{
|
|
"$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"
|
|
},
|
|
"parallel_tool_calls": {
|
|
"type": "boolean",
|
|
"title": "Parallel Tool Calls",
|
|
"default": false
|
|
},
|
|
"previous_response_id": {
|
|
"title": "Previous Response Id",
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"$ref": "#/components/schemas/OpenAIResponsePrompt"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"title": "Status"
|
|
},
|
|
"temperature": {
|
|
"title": "Temperature",
|
|
"type": "number"
|
|
},
|
|
"text": {
|
|
"$ref": "#/components/schemas/OpenAIResponseText",
|
|
"default": {
|
|
"format": {
|
|
"type": "text"
|
|
}
|
|
}
|
|
},
|
|
"top_p": {
|
|
"title": "Top P",
|
|
"type": "number"
|
|
},
|
|
"tools": {
|
|
"title": "Tools",
|
|
"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"
|
|
},
|
|
"truncation": {
|
|
"title": "Truncation",
|
|
"type": "string"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/components/schemas/OpenAIResponseUsage"
|
|
},
|
|
"instructions": {
|
|
"title": "Instructions",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"created_at",
|
|
"id",
|
|
"model",
|
|
"output",
|
|
"status"
|
|
],
|
|
"title": "OpenAIResponseObject",
|
|
"description": "Complete OpenAI response object containing generation results and metadata."
|
|
},
|
|
"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"
|
|
},
|
|
"queries": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Queries"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"title": "Status"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "file_search_call",
|
|
"title": "Type",
|
|
"default": "file_search_call"
|
|
},
|
|
"results": {
|
|
"title": "Results",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"queries",
|
|
"status"
|
|
],
|
|
"title": "OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"description": "File search tool call output message for OpenAI responses."
|
|
},
|
|
"OpenAIResponseOutputMessageFileSearchToolCallResults": {
|
|
"properties": {
|
|
"attributes": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Attributes"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"filename": {
|
|
"type": "string",
|
|
"title": "Filename"
|
|
},
|
|
"score": {
|
|
"type": "number",
|
|
"title": "Score"
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"title": "Text"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"attributes",
|
|
"file_id",
|
|
"filename",
|
|
"score",
|
|
"text"
|
|
],
|
|
"title": "OpenAIResponseOutputMessageFileSearchToolCallResults",
|
|
"description": "Search results returned by the file search operation."
|
|
},
|
|
"OpenAIResponseOutputMessageFunctionToolCall": {
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call Id"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"arguments": {
|
|
"type": "string",
|
|
"title": "Arguments"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "function_call",
|
|
"title": "Type",
|
|
"default": "function_call"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"name",
|
|
"arguments"
|
|
],
|
|
"title": "OpenAIResponseOutputMessageFunctionToolCall",
|
|
"description": "Function tool call output message for OpenAI responses."
|
|
},
|
|
"OpenAIResponseOutputMessageMCPCall": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "mcp_call",
|
|
"title": "Type",
|
|
"default": "mcp_call"
|
|
},
|
|
"arguments": {
|
|
"type": "string",
|
|
"title": "Arguments"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"server_label": {
|
|
"type": "string",
|
|
"title": "Server Label"
|
|
},
|
|
"error": {
|
|
"title": "Error",
|
|
"type": "string"
|
|
},
|
|
"output": {
|
|
"title": "Output",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"arguments",
|
|
"name",
|
|
"server_label"
|
|
],
|
|
"title": "OpenAIResponseOutputMessageMCPCall",
|
|
"description": "Model Context Protocol (MCP) call output message for OpenAI responses."
|
|
},
|
|
"OpenAIResponseOutputMessageMCPListTools": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "mcp_list_tools",
|
|
"title": "Type",
|
|
"default": "mcp_list_tools"
|
|
},
|
|
"server_label": {
|
|
"type": "string",
|
|
"title": "Server Label"
|
|
},
|
|
"tools": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/MCPListToolsTool"
|
|
},
|
|
"type": "array",
|
|
"title": "Tools"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"server_label",
|
|
"tools"
|
|
],
|
|
"title": "OpenAIResponseOutputMessageMCPListTools",
|
|
"description": "MCP list tools output message containing available tools from an MCP server."
|
|
},
|
|
"OpenAIResponseOutputMessageWebSearchToolCall": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"title": "Status"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "web_search_call",
|
|
"title": "Type",
|
|
"default": "web_search_call"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"status"
|
|
],
|
|
"title": "OpenAIResponseOutputMessageWebSearchToolCall",
|
|
"description": "Web search tool call output message for OpenAI responses."
|
|
},
|
|
"OpenAIResponsePrompt": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"variables": {
|
|
"title": "Variables",
|
|
"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"
|
|
},
|
|
"version": {
|
|
"title": "Version",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "OpenAIResponsePrompt",
|
|
"description": "OpenAI compatible Prompt object that is used in OpenAI responses."
|
|
},
|
|
"OpenAIResponseText": {
|
|
"properties": {
|
|
"format": {
|
|
"$ref": "#/components/schemas/OpenAIResponseTextFormat"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseText",
|
|
"description": "Text response configuration for OpenAI responses."
|
|
},
|
|
"OpenAIResponseTextFormat": {
|
|
"properties": {
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"const": "text"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"const": "json_schema"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"const": "json_object"
|
|
}
|
|
],
|
|
"title": "Type"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"schema": {
|
|
"title": "Schema",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"strict": {
|
|
"title": "Strict",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseTextFormat",
|
|
"description": "Configuration for Responses API text format."
|
|
},
|
|
"OpenAIResponseToolMCP": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "mcp",
|
|
"title": "Type",
|
|
"default": "mcp"
|
|
},
|
|
"server_label": {
|
|
"type": "string",
|
|
"title": "Server Label"
|
|
},
|
|
"allowed_tools": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AllowedToolsFilter"
|
|
}
|
|
],
|
|
"title": "Allowed Tools"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"server_label"
|
|
],
|
|
"title": "OpenAIResponseToolMCP",
|
|
"description": "Model Context Protocol (MCP) tool configuration for OpenAI response object."
|
|
},
|
|
"OpenAIResponseUsage": {
|
|
"properties": {
|
|
"input_tokens": {
|
|
"type": "integer",
|
|
"title": "Input Tokens"
|
|
},
|
|
"output_tokens": {
|
|
"type": "integer",
|
|
"title": "Output Tokens"
|
|
},
|
|
"total_tokens": {
|
|
"type": "integer",
|
|
"title": "Total Tokens"
|
|
},
|
|
"input_tokens_details": {
|
|
"$ref": "#/components/schemas/OpenAIResponseUsageInputTokensDetails"
|
|
},
|
|
"output_tokens_details": {
|
|
"$ref": "#/components/schemas/OpenAIResponseUsageOutputTokensDetails"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input_tokens",
|
|
"output_tokens",
|
|
"total_tokens"
|
|
],
|
|
"title": "OpenAIResponseUsage",
|
|
"description": "Usage information for OpenAI response."
|
|
},
|
|
"OpenAIResponseUsageInputTokensDetails": {
|
|
"properties": {
|
|
"cached_tokens": {
|
|
"title": "Cached Tokens",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseUsageInputTokensDetails",
|
|
"description": "Token details for input tokens in OpenAI response usage."
|
|
},
|
|
"OpenAIResponseUsageOutputTokensDetails": {
|
|
"properties": {
|
|
"reasoning_tokens": {
|
|
"title": "Reasoning Tokens",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "OpenAIResponseUsageOutputTokensDetails",
|
|
"description": "Token details for output tokens in OpenAI response usage."
|
|
},
|
|
"OpenAISystemMessageParam": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "system",
|
|
"title": "Role",
|
|
"default": "system"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionContentPartTextParam"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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": {
|
|
"title": "Bytes",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"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."
|
|
},
|
|
"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": {
|
|
"title": "Bytes",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"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."
|
|
},
|
|
"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": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"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": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "OpenAIUserMessageParam",
|
|
"description": "A message from the user in an OpenAI-compatible chat completion request."
|
|
},
|
|
"OptimizerConfig": {
|
|
"properties": {
|
|
"optimizer_type": {
|
|
"$ref": "#/components/schemas/OptimizerType"
|
|
},
|
|
"lr": {
|
|
"type": "number",
|
|
"title": "Lr"
|
|
},
|
|
"weight_decay": {
|
|
"type": "number",
|
|
"title": "Weight Decay"
|
|
},
|
|
"num_warmup_steps": {
|
|
"type": "integer",
|
|
"title": "Num Warmup Steps"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"optimizer_type",
|
|
"lr",
|
|
"weight_decay",
|
|
"num_warmup_steps"
|
|
],
|
|
"title": "OptimizerConfig",
|
|
"description": "Configuration parameters for the optimization algorithm."
|
|
},
|
|
"OptimizerType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"adam",
|
|
"adamw",
|
|
"sgd"
|
|
],
|
|
"title": "OptimizerType",
|
|
"description": "Available optimizer algorithms for training."
|
|
},
|
|
"Order": {
|
|
"type": "string",
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
],
|
|
"title": "Order",
|
|
"description": "Sort order for paginated responses."
|
|
},
|
|
"OutputTokensDetails": {
|
|
"properties": {
|
|
"reasoning_tokens": {
|
|
"type": "integer",
|
|
"title": "Reasoning Tokens"
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"required": [
|
|
"reasoning_tokens"
|
|
],
|
|
"title": "OutputTokensDetails"
|
|
},
|
|
"PostTrainingJob": {
|
|
"properties": {
|
|
"job_uuid": {
|
|
"type": "string",
|
|
"title": "Job Uuid"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"job_uuid"
|
|
],
|
|
"title": "PostTrainingJob"
|
|
},
|
|
"Prompt": {
|
|
"properties": {
|
|
"prompt": {
|
|
"title": "Prompt",
|
|
"description": "The system prompt with variable placeholders",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"minimum": 1.0,
|
|
"title": "Version",
|
|
"description": "Version (integer starting at 1, incremented on save)"
|
|
},
|
|
"prompt_id": {
|
|
"type": "string",
|
|
"title": "Prompt Id",
|
|
"description": "Unique identifier in format 'pmpt_<48-digit-hash>'"
|
|
},
|
|
"variables": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Variables",
|
|
"description": "List of variable names that can be used in the prompt template"
|
|
},
|
|
"is_default": {
|
|
"type": "boolean",
|
|
"title": "Is Default",
|
|
"description": "Boolean indicating whether this version is the default version",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"version",
|
|
"prompt_id"
|
|
],
|
|
"title": "Prompt",
|
|
"description": "A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack."
|
|
},
|
|
"ProviderInfo": {
|
|
"properties": {
|
|
"api": {
|
|
"type": "string",
|
|
"title": "Api"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id"
|
|
},
|
|
"provider_type": {
|
|
"type": "string",
|
|
"title": "Provider Type"
|
|
},
|
|
"config": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Config"
|
|
},
|
|
"health": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Health"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"api",
|
|
"provider_id",
|
|
"provider_type",
|
|
"config",
|
|
"health"
|
|
],
|
|
"title": "ProviderInfo",
|
|
"description": "Information about a registered provider including its configuration and health status."
|
|
},
|
|
"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."
|
|
},
|
|
"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": {
|
|
"default": "vector",
|
|
"$ref": "#/components/schemas/RAGSearchMode"
|
|
},
|
|
"ranker": {
|
|
"title": "Ranker",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RRFRanker"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/WeightedRanker"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"rrf": "#/components/schemas/RRFRanker",
|
|
"weighted": "#/components/schemas/WeightedRanker"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "RAGQueryConfig",
|
|
"description": "Configuration for the RAG query generation."
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "RAGQueryResult",
|
|
"description": "Result of a RAG query containing retrieved content and metadata."
|
|
},
|
|
"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."
|
|
},
|
|
"RegexParserScoringFnParams": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "regex_parser",
|
|
"title": "Type",
|
|
"default": "regex_parser"
|
|
},
|
|
"parsing_regexes": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Parsing Regexes",
|
|
"description": "Regex to extract the answer from generated response"
|
|
},
|
|
"aggregation_functions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/AggregationFunctionType"
|
|
},
|
|
"type": "array",
|
|
"title": "Aggregation Functions",
|
|
"description": "Aggregation functions to apply to the scores of each row"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "RegexParserScoringFnParams",
|
|
"description": "Parameters for regex parser scoring function configuration."
|
|
},
|
|
"RerankData": {
|
|
"properties": {
|
|
"index": {
|
|
"type": "integer",
|
|
"title": "Index"
|
|
},
|
|
"relevance_score": {
|
|
"type": "number",
|
|
"title": "Relevance Score"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"index",
|
|
"relevance_score"
|
|
],
|
|
"title": "RerankData",
|
|
"description": "A single rerank result from a reranking response."
|
|
},
|
|
"RerankResponse": {
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/RerankData"
|
|
},
|
|
"type": "array",
|
|
"title": "Data"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "RerankResponse",
|
|
"description": "Response from a reranking request."
|
|
},
|
|
"RouteInfo": {
|
|
"properties": {
|
|
"route": {
|
|
"type": "string",
|
|
"title": "Route"
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"title": "Method"
|
|
},
|
|
"provider_types": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"title": "Provider Types"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"route",
|
|
"method",
|
|
"provider_types"
|
|
],
|
|
"title": "RouteInfo",
|
|
"description": "Information about an API route including its path, method, and implementing providers."
|
|
},
|
|
"RowsDataSource": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "rows",
|
|
"title": "Type",
|
|
"default": "rows"
|
|
},
|
|
"rows": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array",
|
|
"title": "Rows"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"rows"
|
|
],
|
|
"title": "RowsDataSource",
|
|
"description": "A dataset stored in rows."
|
|
},
|
|
"RunShieldResponse": {
|
|
"properties": {
|
|
"violation": {
|
|
"$ref": "#/components/schemas/SafetyViolation"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "RunShieldResponse",
|
|
"description": "Response from running a safety shield."
|
|
},
|
|
"SafetyViolation": {
|
|
"properties": {
|
|
"violation_level": {
|
|
"$ref": "#/components/schemas/ViolationLevel"
|
|
},
|
|
"user_message": {
|
|
"title": "User Message",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"violation_level"
|
|
],
|
|
"title": "SafetyViolation",
|
|
"description": "Details of a safety violation detected by content moderation."
|
|
},
|
|
"SamplingParams": {
|
|
"properties": {
|
|
"strategy": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/GreedySamplingStrategy"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TopPSamplingStrategy"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TopKSamplingStrategy"
|
|
}
|
|
],
|
|
"title": "Strategy",
|
|
"discriminator": {
|
|
"propertyName": "type",
|
|
"mapping": {
|
|
"greedy": "#/components/schemas/GreedySamplingStrategy",
|
|
"top_k": "#/components/schemas/TopKSamplingStrategy",
|
|
"top_p": "#/components/schemas/TopPSamplingStrategy"
|
|
}
|
|
}
|
|
},
|
|
"max_tokens": {
|
|
"title": "Max Tokens",
|
|
"type": "integer"
|
|
},
|
|
"repetition_penalty": {
|
|
"title": "Repetition Penalty",
|
|
"default": 1.0,
|
|
"type": "number"
|
|
},
|
|
"stop": {
|
|
"title": "Stop",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "SamplingParams",
|
|
"description": "Sampling parameters."
|
|
},
|
|
"ScoreBatchResponse": {
|
|
"properties": {
|
|
"dataset_id": {
|
|
"title": "Dataset Id",
|
|
"type": "string"
|
|
},
|
|
"results": {
|
|
"additionalProperties": {
|
|
"$ref": "#/components/schemas/ScoringResult"
|
|
},
|
|
"type": "object",
|
|
"title": "Results"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"results"
|
|
],
|
|
"title": "ScoreBatchResponse",
|
|
"description": "Response from batch scoring operations on datasets."
|
|
},
|
|
"ScoreResponse": {
|
|
"properties": {
|
|
"results": {
|
|
"additionalProperties": {
|
|
"$ref": "#/components/schemas/ScoringResult"
|
|
},
|
|
"type": "object",
|
|
"title": "Results"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"results"
|
|
],
|
|
"title": "ScoreResponse",
|
|
"description": "The response from scoring."
|
|
},
|
|
"ScoringFn-Input": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"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": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"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": {
|
|
"title": "Params",
|
|
"description": "The parameters for the scoring function for benchmark eval, these can be overridden for app eval",
|
|
"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": "object",
|
|
"required": [
|
|
"identifier",
|
|
"provider_id",
|
|
"return_type"
|
|
],
|
|
"title": "ScoringFn",
|
|
"description": "A scoring function resource for evaluating model outputs."
|
|
},
|
|
"ScoringFn-Output": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"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": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"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": {
|
|
"title": "Params",
|
|
"description": "The parameters for the scoring function for benchmark eval, these can be overridden for app eval",
|
|
"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": "object",
|
|
"required": [
|
|
"identifier",
|
|
"provider_id",
|
|
"return_type"
|
|
],
|
|
"title": "ScoringFn",
|
|
"description": "A scoring function resource for evaluating model outputs."
|
|
},
|
|
"ScoringResult": {
|
|
"properties": {
|
|
"score_rows": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array",
|
|
"title": "Score Rows"
|
|
},
|
|
"aggregated_results": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"title": "Aggregated Results"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"score_rows",
|
|
"aggregated_results"
|
|
],
|
|
"title": "ScoringResult",
|
|
"description": "A scoring result for a single row."
|
|
},
|
|
"SearchRankingOptions": {
|
|
"properties": {
|
|
"ranker": {
|
|
"title": "Ranker",
|
|
"type": "string"
|
|
},
|
|
"score_threshold": {
|
|
"title": "Score Threshold",
|
|
"default": 0.0,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "SearchRankingOptions",
|
|
"description": "Options for ranking and filtering search results."
|
|
},
|
|
"Shield": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id",
|
|
"description": "ID of the provider that owns this resource"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "shield",
|
|
"title": "Type",
|
|
"default": "shield"
|
|
},
|
|
"params": {
|
|
"title": "Params",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"identifier",
|
|
"provider_id"
|
|
],
|
|
"title": "Shield",
|
|
"description": "A safety shield resource that can be used to check content."
|
|
},
|
|
"ShieldCallStep-Input": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "shield_call",
|
|
"title": "Step Type",
|
|
"default": "shield_call"
|
|
},
|
|
"violation": {
|
|
"$ref": "#/components/schemas/SafetyViolation"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"violation"
|
|
],
|
|
"title": "ShieldCallStep",
|
|
"description": "A shield call step in an agent turn."
|
|
},
|
|
"ShieldCallStep-Output": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "shield_call",
|
|
"title": "Step Type",
|
|
"default": "shield_call"
|
|
},
|
|
"violation": {
|
|
"$ref": "#/components/schemas/SafetyViolation"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"violation"
|
|
],
|
|
"title": "ShieldCallStep",
|
|
"description": "A shield call step in an agent turn."
|
|
},
|
|
"StopReason": {
|
|
"type": "string",
|
|
"enum": [
|
|
"end_of_turn",
|
|
"end_of_message",
|
|
"out_of_tokens"
|
|
],
|
|
"title": "StopReason"
|
|
},
|
|
"StringType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "string",
|
|
"title": "Type",
|
|
"default": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "StringType",
|
|
"description": "Parameter type for string values."
|
|
},
|
|
"SystemMessage": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "system",
|
|
"title": "Role",
|
|
"default": "system"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem-Input"
|
|
},
|
|
{
|
|
"$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"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "SystemMessage",
|
|
"description": "A system message providing instructions or context to the model."
|
|
},
|
|
"SystemMessageBehavior": {
|
|
"type": "string",
|
|
"enum": [
|
|
"append",
|
|
"replace"
|
|
],
|
|
"title": "SystemMessageBehavior",
|
|
"description": "Config for how to override the default system prompt."
|
|
},
|
|
"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"
|
|
},
|
|
"ToolCall": {
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call Id"
|
|
},
|
|
"tool_name": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltinTool"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Tool Name"
|
|
},
|
|
"arguments": {
|
|
"type": "string",
|
|
"title": "Arguments"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"tool_name",
|
|
"arguments"
|
|
],
|
|
"title": "ToolCall"
|
|
},
|
|
"ToolChoice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"auto",
|
|
"required",
|
|
"none"
|
|
],
|
|
"title": "ToolChoice",
|
|
"description": "Whether tool use is required or automatic. This is a hint to the model which may not be followed. It depends on the Instruction Following capabilities of the model."
|
|
},
|
|
"ToolConfig": {
|
|
"properties": {
|
|
"tool_choice": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ToolChoice"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Tool Choice",
|
|
"default": "auto"
|
|
},
|
|
"tool_prompt_format": {
|
|
"$ref": "#/components/schemas/ToolPromptFormat"
|
|
},
|
|
"system_message_behavior": {
|
|
"default": "append",
|
|
"$ref": "#/components/schemas/SystemMessageBehavior"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ToolConfig",
|
|
"description": "Configuration for tool use."
|
|
},
|
|
"ToolDef": {
|
|
"properties": {
|
|
"toolgroup_id": {
|
|
"title": "Toolgroup Id",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"input_schema": {
|
|
"title": "Input Schema",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"output_schema": {
|
|
"title": "Output Schema",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"title": "ToolDef",
|
|
"description": "Tool definition used in runtime contexts."
|
|
},
|
|
"ToolExecutionStep-Input": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "tool_execution",
|
|
"title": "Step Type",
|
|
"default": "tool_execution"
|
|
},
|
|
"tool_calls": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
},
|
|
"type": "array",
|
|
"title": "Tool Calls"
|
|
},
|
|
"tool_responses": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolResponse-Input"
|
|
},
|
|
"type": "array",
|
|
"title": "Tool Responses"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"tool_calls",
|
|
"tool_responses"
|
|
],
|
|
"title": "ToolExecutionStep",
|
|
"description": "A tool execution step in an agent turn."
|
|
},
|
|
"ToolExecutionStep-Output": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"step_id": {
|
|
"type": "string",
|
|
"title": "Step Id"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"const": "tool_execution",
|
|
"title": "Step Type",
|
|
"default": "tool_execution"
|
|
},
|
|
"tool_calls": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
},
|
|
"type": "array",
|
|
"title": "Tool Calls"
|
|
},
|
|
"tool_responses": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolResponse-Output"
|
|
},
|
|
"type": "array",
|
|
"title": "Tool Responses"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"tool_calls",
|
|
"tool_responses"
|
|
],
|
|
"title": "ToolExecutionStep",
|
|
"description": "A tool execution step in an agent turn."
|
|
},
|
|
"ToolGroup": {
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"title": "Identifier",
|
|
"description": "Unique identifier for this resource in llama stack"
|
|
},
|
|
"provider_resource_id": {
|
|
"title": "Provider Resource Id",
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"type": "string"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id",
|
|
"description": "ID of the provider that owns this resource"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"const": "tool_group",
|
|
"title": "Type",
|
|
"default": "tool_group"
|
|
},
|
|
"mcp_endpoint": {
|
|
"$ref": "#/components/schemas/URL"
|
|
},
|
|
"args": {
|
|
"title": "Args",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"error_message": {
|
|
"title": "Error Message",
|
|
"type": "string"
|
|
},
|
|
"error_code": {
|
|
"title": "Error Code",
|
|
"type": "integer"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "ToolInvocationResult",
|
|
"description": "Result of a tool invocation."
|
|
},
|
|
"ToolPromptFormat": {
|
|
"type": "string",
|
|
"enum": [
|
|
"json",
|
|
"function_tag",
|
|
"python_list"
|
|
],
|
|
"title": "ToolPromptFormat",
|
|
"description": "Prompt format for calling custom / zero shot tools."
|
|
},
|
|
"ToolResponse-Input": {
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call Id"
|
|
},
|
|
"tool_name": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltinTool"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Tool Name"
|
|
},
|
|
"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"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"tool_name",
|
|
"content"
|
|
],
|
|
"title": "ToolResponse",
|
|
"description": "Response from a tool invocation."
|
|
},
|
|
"ToolResponse-Output": {
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call Id"
|
|
},
|
|
"tool_name": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltinTool"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Tool Name"
|
|
},
|
|
"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"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"tool_name",
|
|
"content"
|
|
],
|
|
"title": "ToolResponse",
|
|
"description": "Response from a tool invocation."
|
|
},
|
|
"ToolResponseMessage-Input": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "tool",
|
|
"title": "Role",
|
|
"default": "tool"
|
|
},
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call 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"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"content"
|
|
],
|
|
"title": "ToolResponseMessage",
|
|
"description": "A message representing the result of a tool invocation."
|
|
},
|
|
"ToolResponseMessage-Output": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "tool",
|
|
"title": "Role",
|
|
"default": "tool"
|
|
},
|
|
"call_id": {
|
|
"type": "string",
|
|
"title": "Call Id"
|
|
},
|
|
"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"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"call_id",
|
|
"content"
|
|
],
|
|
"title": "ToolResponseMessage",
|
|
"description": "A message representing the result of a tool invocation."
|
|
},
|
|
"TopKSamplingStrategy": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "top_k",
|
|
"title": "Type",
|
|
"default": "top_k"
|
|
},
|
|
"top_k": {
|
|
"type": "integer",
|
|
"minimum": 1.0,
|
|
"title": "Top K"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"top_k"
|
|
],
|
|
"title": "TopKSamplingStrategy",
|
|
"description": "Top-k sampling strategy that restricts sampling to the k most likely tokens."
|
|
},
|
|
"TopPSamplingStrategy": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "top_p",
|
|
"title": "Type",
|
|
"default": "top_p"
|
|
},
|
|
"temperature": {
|
|
"title": "Temperature",
|
|
"type": "number",
|
|
"minimum": 0.0
|
|
},
|
|
"top_p": {
|
|
"title": "Top P",
|
|
"default": 0.95,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"temperature"
|
|
],
|
|
"title": "TopPSamplingStrategy",
|
|
"description": "Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p."
|
|
},
|
|
"TrainingConfig": {
|
|
"properties": {
|
|
"n_epochs": {
|
|
"type": "integer",
|
|
"title": "N Epochs"
|
|
},
|
|
"max_steps_per_epoch": {
|
|
"type": "integer",
|
|
"title": "Max Steps Per Epoch",
|
|
"default": 1
|
|
},
|
|
"gradient_accumulation_steps": {
|
|
"type": "integer",
|
|
"title": "Gradient Accumulation Steps",
|
|
"default": 1
|
|
},
|
|
"max_validation_steps": {
|
|
"title": "Max Validation Steps",
|
|
"default": 1,
|
|
"type": "integer"
|
|
},
|
|
"data_config": {
|
|
"$ref": "#/components/schemas/DataConfig"
|
|
},
|
|
"optimizer_config": {
|
|
"$ref": "#/components/schemas/OptimizerConfig"
|
|
},
|
|
"efficiency_config": {
|
|
"$ref": "#/components/schemas/EfficiencyConfig"
|
|
},
|
|
"dtype": {
|
|
"title": "Dtype",
|
|
"default": "bf16",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"n_epochs"
|
|
],
|
|
"title": "TrainingConfig",
|
|
"description": "Comprehensive configuration for the training process."
|
|
},
|
|
"Turn": {
|
|
"properties": {
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"session_id": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
},
|
|
"input_messages": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserMessage-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolResponseMessage-Output"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"title": "Input Messages"
|
|
},
|
|
"steps": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InferenceStep-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolExecutionStep-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ShieldCallStep-Output"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MemoryRetrievalStep-Output"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "step_type",
|
|
"mapping": {
|
|
"inference": "#/components/schemas/InferenceStep-Output",
|
|
"memory_retrieval": "#/components/schemas/MemoryRetrievalStep-Output",
|
|
"shield_call": "#/components/schemas/ShieldCallStep-Output",
|
|
"tool_execution": "#/components/schemas/ToolExecutionStep-Output"
|
|
}
|
|
}
|
|
},
|
|
"type": "array",
|
|
"title": "Steps"
|
|
},
|
|
"output_message": {
|
|
"$ref": "#/components/schemas/CompletionMessage-Output"
|
|
},
|
|
"output_attachments": {
|
|
"title": "Output Attachments",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Attachment-Output"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"started_at": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "Started At"
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"turn_id",
|
|
"session_id",
|
|
"input_messages",
|
|
"steps",
|
|
"output_message",
|
|
"started_at"
|
|
],
|
|
"title": "Turn",
|
|
"description": "A single turn in an interaction with an Agentic System."
|
|
},
|
|
"URIDataSource": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "uri",
|
|
"title": "Type",
|
|
"default": "uri"
|
|
},
|
|
"uri": {
|
|
"type": "string",
|
|
"title": "Uri"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"uri"
|
|
],
|
|
"title": "URIDataSource",
|
|
"description": "A dataset that can be obtained from a URI."
|
|
},
|
|
"URL": {
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string",
|
|
"title": "Uri"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"uri"
|
|
],
|
|
"title": "URL",
|
|
"description": "A URL reference to external content."
|
|
},
|
|
"UnionType": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"const": "union",
|
|
"title": "Type",
|
|
"default": "union"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "UnionType",
|
|
"description": "Parameter type for union values."
|
|
},
|
|
"UserMessage-Input": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "user",
|
|
"title": "Role",
|
|
"default": "user"
|
|
},
|
|
"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"
|
|
},
|
|
"context": {
|
|
"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": "Context"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "UserMessage",
|
|
"description": "A message from the user in a chat conversation."
|
|
},
|
|
"UserMessage-Output": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"const": "user",
|
|
"title": "Role",
|
|
"default": "user"
|
|
},
|
|
"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"
|
|
},
|
|
"context": {
|
|
"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": "Context"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "UserMessage",
|
|
"description": "A message from the user in a chat conversation."
|
|
},
|
|
"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."
|
|
},
|
|
"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."
|
|
},
|
|
"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."
|
|
},
|
|
"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": {
|
|
"$ref": "#/components/schemas/VectorStoreFileLastError"
|
|
},
|
|
"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."
|
|
},
|
|
"VectorStoreObject": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Id"
|
|
},
|
|
"object": {
|
|
"type": "string",
|
|
"title": "Object",
|
|
"default": "vector_store"
|
|
},
|
|
"created_at": {
|
|
"type": "integer",
|
|
"title": "Created At"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"usage_bytes": {
|
|
"type": "integer",
|
|
"title": "Usage Bytes",
|
|
"default": 0
|
|
},
|
|
"file_counts": {
|
|
"$ref": "#/components/schemas/VectorStoreFileCounts"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"title": "Status",
|
|
"default": "completed"
|
|
},
|
|
"expires_after": {
|
|
"title": "Expires After",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"expires_at": {
|
|
"title": "Expires At",
|
|
"type": "integer"
|
|
},
|
|
"last_active_at": {
|
|
"title": "Last Active At",
|
|
"type": "integer"
|
|
},
|
|
"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": {
|
|
"title": "Attributes",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
}
|
|
]
|
|
},
|
|
"type": "object"
|
|
},
|
|
"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": {
|
|
"title": "Next Page",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"search_query",
|
|
"data"
|
|
],
|
|
"title": "VectorStoreSearchResponsePage",
|
|
"description": "Paginated response from searching a vector store."
|
|
},
|
|
"VersionInfo": {
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"title": "Version"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"version"
|
|
],
|
|
"title": "VersionInfo",
|
|
"description": "Version information for the service."
|
|
},
|
|
"ViolationLevel": {
|
|
"type": "string",
|
|
"enum": [
|
|
"info",
|
|
"warn",
|
|
"error"
|
|
],
|
|
"title": "ViolationLevel",
|
|
"description": "Severity level of a safety violation."
|
|
},
|
|
"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."
|
|
},
|
|
"_URLOrData": {
|
|
"properties": {
|
|
"url": {
|
|
"$ref": "#/components/schemas/URL"
|
|
},
|
|
"data": {
|
|
"contentEncoding": "base64",
|
|
"title": "Data",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"title": "_URLOrData",
|
|
"description": "A URL or a base64 encoded string"
|
|
},
|
|
"__main_____agents_agent_id_session_Request": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"session_name": {
|
|
"type": "string",
|
|
"title": "Session Name"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"agent_id",
|
|
"session_name"
|
|
],
|
|
"title": "_agents_agent_id_session_Request"
|
|
},
|
|
"__main_____agents_agent_id_session_session_id_turn_Request": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"session_id": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
},
|
|
"messages": {
|
|
"$ref": "#/components/schemas/UserMessage-Input"
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"title": "Stream",
|
|
"default": false
|
|
},
|
|
"documents": {
|
|
"$ref": "#/components/schemas/Document"
|
|
},
|
|
"toolgroups": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentToolGroupWithArgs"
|
|
}
|
|
],
|
|
"title": "Toolgroups"
|
|
},
|
|
"tool_config": {
|
|
"$ref": "#/components/schemas/ToolConfig"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"agent_id",
|
|
"session_id",
|
|
"messages",
|
|
"documents",
|
|
"toolgroups",
|
|
"tool_config"
|
|
],
|
|
"title": "_agents_agent_id_session_session_id_turn_Request"
|
|
},
|
|
"__main_____agents_agent_id_session_session_id_turn_turn_id_resume_Request": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"type": "string",
|
|
"title": "Agent Id"
|
|
},
|
|
"session_id": {
|
|
"type": "string",
|
|
"title": "Session Id"
|
|
},
|
|
"turn_id": {
|
|
"type": "string",
|
|
"title": "Turn Id"
|
|
},
|
|
"tool_responses": {
|
|
"$ref": "#/components/schemas/ToolResponse-Input"
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"title": "Stream",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"agent_id",
|
|
"session_id",
|
|
"turn_id",
|
|
"tool_responses"
|
|
],
|
|
"title": "_agents_agent_id_session_session_id_turn_turn_id_resume_Request"
|
|
},
|
|
"__main_____datasets_Request": {
|
|
"properties": {
|
|
"purpose": {
|
|
"$ref": "#/components/schemas/DatasetPurpose"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
},
|
|
"dataset_id": {
|
|
"type": "string",
|
|
"title": "Dataset Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"purpose",
|
|
"metadata",
|
|
"dataset_id"
|
|
],
|
|
"title": "_datasets_Request"
|
|
},
|
|
"_batches_Request": {
|
|
"properties": {
|
|
"input_file_id": {
|
|
"type": "string",
|
|
"title": "Input File Id"
|
|
},
|
|
"endpoint": {
|
|
"type": "string",
|
|
"title": "Endpoint"
|
|
},
|
|
"completion_window": {
|
|
"type": "string",
|
|
"title": "Completion Window"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
},
|
|
"idempotency_key": {
|
|
"type": "string",
|
|
"title": "Idempotency Key"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input_file_id",
|
|
"endpoint",
|
|
"completion_window",
|
|
"metadata",
|
|
"idempotency_key"
|
|
],
|
|
"title": "_batches_Request"
|
|
},
|
|
"_batches_batch_id_cancel_Request": {
|
|
"properties": {
|
|
"batch_id": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"batch_id"
|
|
],
|
|
"title": "_batches_batch_id_cancel_Request"
|
|
},
|
|
"_conversations_Request": {
|
|
"properties": {
|
|
"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"
|
|
}
|
|
],
|
|
"title": "Items",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"items",
|
|
"metadata"
|
|
],
|
|
"title": "_conversations_Request"
|
|
},
|
|
"_conversations_conversation_id_Request": {
|
|
"properties": {
|
|
"conversation_id": {
|
|
"type": "string",
|
|
"title": "Conversation Id"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"conversation_id",
|
|
"metadata"
|
|
],
|
|
"title": "_conversations_conversation_id_Request"
|
|
},
|
|
"_conversations_conversation_id_items_Request": {
|
|
"properties": {
|
|
"conversation_id": {
|
|
"type": "string",
|
|
"title": "Conversation Id"
|
|
},
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"$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"
|
|
}
|
|
],
|
|
"title": "Items"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"conversation_id",
|
|
"items"
|
|
],
|
|
"title": "_conversations_conversation_id_items_Request"
|
|
},
|
|
"_inference_rerank_Request": {
|
|
"properties": {
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"query": {
|
|
"type": "string",
|
|
"title": "Query"
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"title": "Items"
|
|
},
|
|
"max_num_results": {
|
|
"type": "integer",
|
|
"title": "Max Num Results"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"model",
|
|
"query",
|
|
"items",
|
|
"max_num_results"
|
|
],
|
|
"title": "_inference_rerank_Request"
|
|
},
|
|
"_models_Request": {
|
|
"properties": {
|
|
"model_id": {
|
|
"type": "string",
|
|
"title": "Model Id"
|
|
},
|
|
"provider_model_id": {
|
|
"type": "string",
|
|
"title": "Provider Model Id"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
},
|
|
"model_type": {
|
|
"$ref": "#/components/schemas/ModelType"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"model_id",
|
|
"provider_model_id",
|
|
"provider_id",
|
|
"metadata",
|
|
"model_type"
|
|
],
|
|
"title": "_models_Request"
|
|
},
|
|
"_moderations_Request": {
|
|
"properties": {
|
|
"input": {
|
|
"type": "string",
|
|
"title": "Input"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input",
|
|
"model"
|
|
],
|
|
"title": "_moderations_Request"
|
|
},
|
|
"_openai_v1_batches_Request": {
|
|
"properties": {
|
|
"input_file_id": {
|
|
"type": "string",
|
|
"title": "Input File Id"
|
|
},
|
|
"endpoint": {
|
|
"type": "string",
|
|
"title": "Endpoint"
|
|
},
|
|
"completion_window": {
|
|
"type": "string",
|
|
"title": "Completion Window"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
},
|
|
"idempotency_key": {
|
|
"type": "string",
|
|
"title": "Idempotency Key"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input_file_id",
|
|
"endpoint",
|
|
"completion_window",
|
|
"metadata",
|
|
"idempotency_key"
|
|
],
|
|
"title": "_openai_v1_batches_Request"
|
|
},
|
|
"_openai_v1_batches_batch_id_cancel_Request": {
|
|
"properties": {
|
|
"batch_id": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"batch_id"
|
|
],
|
|
"title": "_openai_v1_batches_batch_id_cancel_Request"
|
|
},
|
|
"_openai_v1_moderations_Request": {
|
|
"properties": {
|
|
"input": {
|
|
"type": "string",
|
|
"title": "Input"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input",
|
|
"model"
|
|
],
|
|
"title": "_openai_v1_moderations_Request"
|
|
},
|
|
"_openai_v1_responses_Request": {
|
|
"properties": {
|
|
"input": {
|
|
"type": "string",
|
|
"title": "Input"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"prompt": {
|
|
"$ref": "#/components/schemas/OpenAIResponsePrompt"
|
|
},
|
|
"instructions": {
|
|
"type": "string",
|
|
"title": "Instructions"
|
|
},
|
|
"previous_response_id": {
|
|
"type": "string",
|
|
"title": "Previous Response Id"
|
|
},
|
|
"conversation": {
|
|
"type": "string",
|
|
"title": "Conversation"
|
|
},
|
|
"store": {
|
|
"type": "boolean",
|
|
"title": "Store",
|
|
"default": true
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"title": "Stream",
|
|
"default": false
|
|
},
|
|
"temperature": {
|
|
"type": "number",
|
|
"title": "Temperature"
|
|
},
|
|
"text": {
|
|
"$ref": "#/components/schemas/OpenAIResponseText"
|
|
},
|
|
"tools": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolWebSearch"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolFileSearch"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolFunction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolMCP"
|
|
}
|
|
],
|
|
"title": "Tools",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"include": {
|
|
"type": "string",
|
|
"title": "Include"
|
|
},
|
|
"max_infer_iters": {
|
|
"type": "integer",
|
|
"title": "Max Infer Iters",
|
|
"default": 10
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input",
|
|
"model",
|
|
"prompt",
|
|
"instructions",
|
|
"previous_response_id",
|
|
"conversation",
|
|
"temperature",
|
|
"text",
|
|
"tools",
|
|
"include"
|
|
],
|
|
"title": "_openai_v1_responses_Request"
|
|
},
|
|
"_openai_v1_vector_stores_vector_store_id_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"expires_after": {
|
|
"type": "string",
|
|
"title": "Expires After"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"name",
|
|
"expires_after",
|
|
"metadata"
|
|
],
|
|
"title": "_openai_v1_vector_stores_vector_store_id_Request"
|
|
},
|
|
"_openai_v1_vector_stores_vector_store_id_file_batches_batch_id_cancel_Request": {
|
|
"properties": {
|
|
"batch_id": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
},
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"batch_id",
|
|
"vector_store_id"
|
|
],
|
|
"title": "_openai_v1_vector_stores_vector_store_id_file_batches_batch_id_cancel_Request"
|
|
},
|
|
"_openai_v1_vector_stores_vector_store_id_files_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"attributes": {
|
|
"type": "string",
|
|
"title": "Attributes"
|
|
},
|
|
"chunking_strategy": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VectorStoreChunkingStrategyAuto"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VectorStoreChunkingStrategyStatic"
|
|
}
|
|
],
|
|
"title": "Chunking Strategy"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"file_id",
|
|
"attributes",
|
|
"chunking_strategy"
|
|
],
|
|
"title": "_openai_v1_vector_stores_vector_store_id_files_Request"
|
|
},
|
|
"_openai_v1_vector_stores_vector_store_id_files_file_id_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"attributes": {
|
|
"type": "string",
|
|
"title": "Attributes"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"file_id",
|
|
"attributes"
|
|
],
|
|
"title": "_openai_v1_vector_stores_vector_store_id_files_file_id_Request"
|
|
},
|
|
"_openai_v1_vector_stores_vector_store_id_search_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"query": {
|
|
"type": "string",
|
|
"title": "Query"
|
|
},
|
|
"filters": {
|
|
"type": "string",
|
|
"title": "Filters"
|
|
},
|
|
"max_num_results": {
|
|
"type": "integer",
|
|
"title": "Max Num Results",
|
|
"default": 10
|
|
},
|
|
"ranking_options": {
|
|
"$ref": "#/components/schemas/SearchRankingOptions"
|
|
},
|
|
"rewrite_query": {
|
|
"type": "boolean",
|
|
"title": "Rewrite Query",
|
|
"default": false
|
|
},
|
|
"search_mode": {
|
|
"type": "string",
|
|
"title": "Search Mode",
|
|
"default": "vector"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"query",
|
|
"filters",
|
|
"ranking_options"
|
|
],
|
|
"title": "_openai_v1_vector_stores_vector_store_id_search_Request"
|
|
},
|
|
"_prompts_Request": {
|
|
"properties": {
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"variables": {
|
|
"type": "string",
|
|
"title": "Variables"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt",
|
|
"variables"
|
|
],
|
|
"title": "_prompts_Request"
|
|
},
|
|
"_prompts_prompt_id_Request": {
|
|
"properties": {
|
|
"prompt_id": {
|
|
"type": "string",
|
|
"title": "Prompt Id"
|
|
},
|
|
"prompt": {
|
|
"type": "string",
|
|
"title": "Prompt"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"title": "Version"
|
|
},
|
|
"variables": {
|
|
"type": "string",
|
|
"title": "Variables"
|
|
},
|
|
"set_as_default": {
|
|
"type": "boolean",
|
|
"title": "Set As Default",
|
|
"default": true
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt_id",
|
|
"prompt",
|
|
"version",
|
|
"variables"
|
|
],
|
|
"title": "_prompts_prompt_id_Request"
|
|
},
|
|
"_prompts_prompt_id_set_default_version_Request": {
|
|
"properties": {
|
|
"prompt_id": {
|
|
"type": "string",
|
|
"title": "Prompt Id"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"title": "Version"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"prompt_id",
|
|
"version"
|
|
],
|
|
"title": "_prompts_prompt_id_set_default_version_Request"
|
|
},
|
|
"_responses_Request": {
|
|
"properties": {
|
|
"input": {
|
|
"type": "string",
|
|
"title": "Input"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"title": "Model"
|
|
},
|
|
"prompt": {
|
|
"$ref": "#/components/schemas/OpenAIResponsePrompt"
|
|
},
|
|
"instructions": {
|
|
"type": "string",
|
|
"title": "Instructions"
|
|
},
|
|
"previous_response_id": {
|
|
"type": "string",
|
|
"title": "Previous Response Id"
|
|
},
|
|
"conversation": {
|
|
"type": "string",
|
|
"title": "Conversation"
|
|
},
|
|
"store": {
|
|
"type": "boolean",
|
|
"title": "Store",
|
|
"default": true
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"title": "Stream",
|
|
"default": false
|
|
},
|
|
"temperature": {
|
|
"type": "number",
|
|
"title": "Temperature"
|
|
},
|
|
"text": {
|
|
"$ref": "#/components/schemas/OpenAIResponseText"
|
|
},
|
|
"tools": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolWebSearch"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolFileSearch"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolFunction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolMCP"
|
|
}
|
|
],
|
|
"title": "Tools",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"include": {
|
|
"type": "string",
|
|
"title": "Include"
|
|
},
|
|
"max_infer_iters": {
|
|
"type": "integer",
|
|
"title": "Max Infer Iters",
|
|
"default": 10
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input",
|
|
"model",
|
|
"prompt",
|
|
"instructions",
|
|
"previous_response_id",
|
|
"conversation",
|
|
"temperature",
|
|
"text",
|
|
"tools",
|
|
"include"
|
|
],
|
|
"title": "_responses_Request"
|
|
},
|
|
"_scoring_score_Request": {
|
|
"properties": {
|
|
"input_rows": {
|
|
"type": "string",
|
|
"title": "Input Rows"
|
|
},
|
|
"scoring_functions": {
|
|
"type": "string",
|
|
"title": "Scoring Functions"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"input_rows",
|
|
"scoring_functions"
|
|
],
|
|
"title": "_scoring_score_Request"
|
|
},
|
|
"_scoring_score_batch_Request": {
|
|
"properties": {
|
|
"dataset_id": {
|
|
"type": "string",
|
|
"title": "Dataset Id"
|
|
},
|
|
"scoring_functions": {
|
|
"type": "string",
|
|
"title": "Scoring Functions"
|
|
},
|
|
"save_results_dataset": {
|
|
"type": "boolean",
|
|
"title": "Save Results Dataset",
|
|
"default": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"dataset_id",
|
|
"scoring_functions"
|
|
],
|
|
"title": "_scoring_score_batch_Request"
|
|
},
|
|
"_shields_Request": {
|
|
"properties": {
|
|
"shield_id": {
|
|
"type": "string",
|
|
"title": "Shield Id"
|
|
},
|
|
"provider_shield_id": {
|
|
"type": "string",
|
|
"title": "Provider Shield Id"
|
|
},
|
|
"provider_id": {
|
|
"type": "string",
|
|
"title": "Provider Id"
|
|
},
|
|
"params": {
|
|
"type": "string",
|
|
"title": "Params"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"shield_id",
|
|
"provider_shield_id",
|
|
"provider_id",
|
|
"params"
|
|
],
|
|
"title": "_shields_Request"
|
|
},
|
|
"_tool_runtime_invoke_Request": {
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string",
|
|
"title": "Tool Name"
|
|
},
|
|
"kwargs": {
|
|
"type": "string",
|
|
"title": "Kwargs"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"tool_name",
|
|
"kwargs"
|
|
],
|
|
"title": "_tool_runtime_invoke_Request"
|
|
},
|
|
"_tool_runtime_rag_tool_query_Request": {
|
|
"properties": {
|
|
"content": {
|
|
"type": "string",
|
|
"title": "Content"
|
|
},
|
|
"vector_store_ids": {
|
|
"type": "string",
|
|
"title": "Vector Store Ids"
|
|
},
|
|
"query_config": {
|
|
"$ref": "#/components/schemas/RAGQueryConfig"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"content",
|
|
"vector_store_ids",
|
|
"query_config"
|
|
],
|
|
"title": "_tool_runtime_rag_tool_query_Request"
|
|
},
|
|
"_vector_io_query_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"query": {
|
|
"type": "string",
|
|
"title": "Query"
|
|
},
|
|
"params": {
|
|
"type": "string",
|
|
"title": "Params"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"query",
|
|
"params"
|
|
],
|
|
"title": "_vector_io_query_Request"
|
|
},
|
|
"_vector_stores_vector_store_id_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Name"
|
|
},
|
|
"expires_after": {
|
|
"type": "string",
|
|
"title": "Expires After"
|
|
},
|
|
"metadata": {
|
|
"type": "string",
|
|
"title": "Metadata"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"name",
|
|
"expires_after",
|
|
"metadata"
|
|
],
|
|
"title": "_vector_stores_vector_store_id_Request"
|
|
},
|
|
"_vector_stores_vector_store_id_file_batches_batch_id_cancel_Request": {
|
|
"properties": {
|
|
"batch_id": {
|
|
"type": "string",
|
|
"title": "Batch Id"
|
|
},
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"batch_id",
|
|
"vector_store_id"
|
|
],
|
|
"title": "_vector_stores_vector_store_id_file_batches_batch_id_cancel_Request"
|
|
},
|
|
"_vector_stores_vector_store_id_files_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"attributes": {
|
|
"type": "string",
|
|
"title": "Attributes"
|
|
},
|
|
"chunking_strategy": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VectorStoreChunkingStrategyAuto"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/VectorStoreChunkingStrategyStatic"
|
|
}
|
|
],
|
|
"title": "Chunking Strategy"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"file_id",
|
|
"attributes",
|
|
"chunking_strategy"
|
|
],
|
|
"title": "_vector_stores_vector_store_id_files_Request"
|
|
},
|
|
"_vector_stores_vector_store_id_files_file_id_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"file_id": {
|
|
"type": "string",
|
|
"title": "File Id"
|
|
},
|
|
"attributes": {
|
|
"type": "string",
|
|
"title": "Attributes"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"file_id",
|
|
"attributes"
|
|
],
|
|
"title": "_vector_stores_vector_store_id_files_file_id_Request"
|
|
},
|
|
"_vector_stores_vector_store_id_search_Request": {
|
|
"properties": {
|
|
"vector_store_id": {
|
|
"type": "string",
|
|
"title": "Vector Store Id"
|
|
},
|
|
"query": {
|
|
"type": "string",
|
|
"title": "Query"
|
|
},
|
|
"filters": {
|
|
"type": "string",
|
|
"title": "Filters"
|
|
},
|
|
"max_num_results": {
|
|
"type": "integer",
|
|
"title": "Max Num Results",
|
|
"default": 10
|
|
},
|
|
"ranking_options": {
|
|
"$ref": "#/components/schemas/SearchRankingOptions"
|
|
},
|
|
"rewrite_query": {
|
|
"type": "boolean",
|
|
"title": "Rewrite Query",
|
|
"default": false
|
|
},
|
|
"search_mode": {
|
|
"type": "string",
|
|
"title": "Search Mode",
|
|
"default": "vector"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"required": [
|
|
"vector_store_id",
|
|
"query",
|
|
"filters",
|
|
"ranking_options"
|
|
],
|
|
"title": "_vector_stores_vector_store_id_search_Request"
|
|
},
|
|
"Error": {
|
|
"description": "Error response from the API. Roughly follows RFC 7807.",
|
|
"properties": {
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"title": "Title",
|
|
"type": "string"
|
|
},
|
|
"detail": {
|
|
"title": "Detail",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"title": "Instance",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"status",
|
|
"title",
|
|
"detail"
|
|
],
|
|
"title": "Error",
|
|
"type": "object"
|
|
},
|
|
"Agent": {
|
|
"description": "An agent instance with configuration and metadata.",
|
|
"properties": {
|
|
"agent_id": {
|
|
"title": "Agent Id",
|
|
"type": "string"
|
|
},
|
|
"agent_config": {
|
|
"$ref": "#/components/schemas/AgentConfig"
|
|
},
|
|
"created_at": {
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"agent_id",
|
|
"agent_config",
|
|
"created_at"
|
|
],
|
|
"title": "Agent",
|
|
"type": "object"
|
|
},
|
|
"AgentStepResponse": {
|
|
"description": "Response containing details of a specific agent step.",
|
|
"properties": {
|
|
"step": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"inference": "#/$defs/InferenceStep",
|
|
"memory_retrieval": "#/$defs/MemoryRetrievalStep",
|
|
"shield_call": "#/$defs/ShieldCallStep",
|
|
"tool_execution": "#/$defs/ToolExecutionStep"
|
|
},
|
|
"propertyName": "step_type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InferenceStep"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolExecutionStep"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ShieldCallStep"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MemoryRetrievalStep"
|
|
}
|
|
],
|
|
"title": "Step"
|
|
}
|
|
},
|
|
"required": [
|
|
"step"
|
|
],
|
|
"title": "AgentStepResponse",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnCreateRequest": {
|
|
"description": "Request to create a new turn for an agent.",
|
|
"properties": {
|
|
"sampling_params": {
|
|
"$ref": "#/components/schemas/SamplingParams"
|
|
},
|
|
"input_shields": {
|
|
"title": "Input Shields",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"output_shields": {
|
|
"title": "Output Shields",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"toolgroups": {
|
|
"title": "Toolgroups",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentToolGroupWithArgs"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"client_tools": {
|
|
"title": "Client Tools",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolDef"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"tool_choice": {
|
|
"deprecated": true,
|
|
"$ref": "#/components/schemas/ToolChoice",
|
|
"nullable": true
|
|
},
|
|
"tool_prompt_format": {
|
|
"deprecated": true,
|
|
"$ref": "#/components/schemas/ToolPromptFormat",
|
|
"nullable": true
|
|
},
|
|
"tool_config": {
|
|
"$ref": "#/components/schemas/ToolConfig",
|
|
"nullable": true
|
|
},
|
|
"max_infer_iters": {
|
|
"default": 10,
|
|
"title": "Max Infer Iters",
|
|
"type": "integer"
|
|
},
|
|
"instructions": {
|
|
"title": "Instructions",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"agent_id": {
|
|
"title": "Agent Id",
|
|
"type": "string"
|
|
},
|
|
"session_id": {
|
|
"title": "Session Id",
|
|
"type": "string"
|
|
},
|
|
"messages": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolResponseMessage"
|
|
}
|
|
]
|
|
},
|
|
"title": "Messages",
|
|
"type": "array"
|
|
},
|
|
"documents": {
|
|
"title": "Documents",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Document"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"agent_id",
|
|
"session_id",
|
|
"messages"
|
|
],
|
|
"title": "AgentTurnCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseEvent": {
|
|
"description": "An event in an agent turn response stream.",
|
|
"properties": {
|
|
"payload": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"step_complete": "#/$defs/AgentTurnResponseStepCompletePayload",
|
|
"step_progress": "#/$defs/AgentTurnResponseStepProgressPayload",
|
|
"step_start": "#/$defs/AgentTurnResponseStepStartPayload",
|
|
"turn_awaiting_input": "#/$defs/AgentTurnResponseTurnAwaitingInputPayload",
|
|
"turn_complete": "#/$defs/AgentTurnResponseTurnCompletePayload",
|
|
"turn_start": "#/$defs/AgentTurnResponseTurnStartPayload"
|
|
},
|
|
"propertyName": "event_type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AgentTurnResponseStepStartPayload"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentTurnResponseStepProgressPayload"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentTurnResponseStepCompletePayload"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentTurnResponseTurnStartPayload"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentTurnResponseTurnCompletePayload"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentTurnResponseTurnAwaitingInputPayload"
|
|
}
|
|
],
|
|
"title": "Payload"
|
|
}
|
|
},
|
|
"required": [
|
|
"payload"
|
|
],
|
|
"title": "AgentTurnResponseEvent",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseStepCompletePayload": {
|
|
"description": "Payload for step completion events in agent turn responses.",
|
|
"properties": {
|
|
"event_type": {
|
|
"const": "step_complete",
|
|
"default": "step_complete",
|
|
"title": "Event Type",
|
|
"type": "string"
|
|
},
|
|
"step_type": {
|
|
"$ref": "#/components/schemas/StepType"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"step_details": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"inference": "#/$defs/InferenceStep",
|
|
"memory_retrieval": "#/$defs/MemoryRetrievalStep",
|
|
"shield_call": "#/$defs/ShieldCallStep",
|
|
"tool_execution": "#/$defs/ToolExecutionStep"
|
|
},
|
|
"propertyName": "step_type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InferenceStep"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolExecutionStep"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ShieldCallStep"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MemoryRetrievalStep"
|
|
}
|
|
],
|
|
"title": "Step Details"
|
|
}
|
|
},
|
|
"required": [
|
|
"step_type",
|
|
"step_id",
|
|
"step_details"
|
|
],
|
|
"title": "AgentTurnResponseStepCompletePayload",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseStepProgressPayload": {
|
|
"description": "Payload for step progress events in agent turn responses.",
|
|
"properties": {
|
|
"event_type": {
|
|
"const": "step_progress",
|
|
"default": "step_progress",
|
|
"title": "Event Type",
|
|
"type": "string"
|
|
},
|
|
"step_type": {
|
|
"$ref": "#/components/schemas/StepType"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"delta": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageDelta",
|
|
"text": "#/$defs/TextDelta",
|
|
"tool_call": "#/$defs/ToolCallDelta"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TextDelta"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ImageDelta"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolCallDelta"
|
|
}
|
|
],
|
|
"title": "Delta"
|
|
}
|
|
},
|
|
"required": [
|
|
"step_type",
|
|
"step_id",
|
|
"delta"
|
|
],
|
|
"title": "AgentTurnResponseStepProgressPayload",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseStepStartPayload": {
|
|
"description": "Payload for step start events in agent turn responses.",
|
|
"properties": {
|
|
"event_type": {
|
|
"const": "step_start",
|
|
"default": "step_start",
|
|
"title": "Event Type",
|
|
"type": "string"
|
|
},
|
|
"step_type": {
|
|
"$ref": "#/components/schemas/StepType"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"step_type",
|
|
"step_id"
|
|
],
|
|
"title": "AgentTurnResponseStepStartPayload",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseStreamChunk": {
|
|
"description": "Streamed agent turn completion response.",
|
|
"properties": {
|
|
"event": {
|
|
"$ref": "#/components/schemas/AgentTurnResponseEvent"
|
|
}
|
|
},
|
|
"required": [
|
|
"event"
|
|
],
|
|
"title": "AgentTurnResponseStreamChunk",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseTurnAwaitingInputPayload": {
|
|
"description": "Payload for turn awaiting input events in agent turn responses.",
|
|
"properties": {
|
|
"event_type": {
|
|
"const": "turn_awaiting_input",
|
|
"default": "turn_awaiting_input",
|
|
"title": "Event Type",
|
|
"type": "string"
|
|
},
|
|
"turn": {
|
|
"$ref": "#/components/schemas/Turn"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn"
|
|
],
|
|
"title": "AgentTurnResponseTurnAwaitingInputPayload",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseTurnCompletePayload": {
|
|
"description": "Payload for turn completion events in agent turn responses.",
|
|
"properties": {
|
|
"event_type": {
|
|
"const": "turn_complete",
|
|
"default": "turn_complete",
|
|
"title": "Event Type",
|
|
"type": "string"
|
|
},
|
|
"turn": {
|
|
"$ref": "#/components/schemas/Turn"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn"
|
|
],
|
|
"title": "AgentTurnResponseTurnCompletePayload",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResponseTurnStartPayload": {
|
|
"description": "Payload for turn start events in agent turn responses.",
|
|
"properties": {
|
|
"event_type": {
|
|
"const": "turn_start",
|
|
"default": "turn_start",
|
|
"title": "Event Type",
|
|
"type": "string"
|
|
},
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn_id"
|
|
],
|
|
"title": "AgentTurnResponseTurnStartPayload",
|
|
"type": "object"
|
|
},
|
|
"AgentTurnResumeRequest": {
|
|
"description": "Request to resume an agent turn with tool responses.",
|
|
"properties": {
|
|
"agent_id": {
|
|
"title": "Agent Id",
|
|
"type": "string"
|
|
},
|
|
"session_id": {
|
|
"title": "Session Id",
|
|
"type": "string"
|
|
},
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
},
|
|
"tool_responses": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolResponse"
|
|
},
|
|
"title": "Tool Responses",
|
|
"type": "array"
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"agent_id",
|
|
"session_id",
|
|
"turn_id",
|
|
"tool_responses"
|
|
],
|
|
"title": "AgentTurnResumeRequest",
|
|
"type": "object"
|
|
},
|
|
"CompletionMessage": {
|
|
"description": "A message containing the model's (assistant) response in a chat conversation.",
|
|
"properties": {
|
|
"role": {
|
|
"const": "assistant",
|
|
"default": "assistant",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"stop_reason": {
|
|
"$ref": "#/components/schemas/StopReason"
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"content",
|
|
"stop_reason"
|
|
],
|
|
"title": "CompletionMessage",
|
|
"type": "object"
|
|
},
|
|
"InferenceStep": {
|
|
"description": "An inference step in an agent turn.",
|
|
"properties": {
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"step_type": {
|
|
"const": "inference",
|
|
"default": "inference",
|
|
"title": "Step Type",
|
|
"type": "string"
|
|
},
|
|
"model_response": {
|
|
"$ref": "#/components/schemas/CompletionMessage"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"model_response"
|
|
],
|
|
"title": "InferenceStep",
|
|
"type": "object"
|
|
},
|
|
"ListOpenAIResponseInputItem": {
|
|
"description": "List container for OpenAI response input items.",
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputFunctionToolCallOutput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
}
|
|
]
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListOpenAIResponseInputItem",
|
|
"type": "object"
|
|
},
|
|
"ListOpenAIResponseObject": {
|
|
"description": "Paginated list of OpenAI response objects with navigation metadata.",
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObjectWithInput"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"has_more": {
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
},
|
|
"first_id": {
|
|
"title": "First Id",
|
|
"type": "string"
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"has_more",
|
|
"first_id",
|
|
"last_id"
|
|
],
|
|
"title": "ListOpenAIResponseObject",
|
|
"type": "object"
|
|
},
|
|
"MemoryRetrievalStep": {
|
|
"description": "A memory retrieval step in an agent turn.",
|
|
"properties": {
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"step_type": {
|
|
"const": "memory_retrieval",
|
|
"default": "memory_retrieval",
|
|
"title": "Step Type",
|
|
"type": "string"
|
|
},
|
|
"vector_store_ids": {
|
|
"title": "Vector Store Ids",
|
|
"type": "string"
|
|
},
|
|
"inserted_context": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Inserted Context"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"vector_store_ids",
|
|
"inserted_context"
|
|
],
|
|
"title": "MemoryRetrievalStep",
|
|
"type": "object"
|
|
},
|
|
"OpenAIDeleteResponseObject": {
|
|
"description": "Response object confirming deletion of an OpenAI response.",
|
|
"properties": {
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "response",
|
|
"default": "response",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"deleted": {
|
|
"default": true,
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "OpenAIDeleteResponseObject",
|
|
"type": "object"
|
|
},
|
|
"PaginatedResponse": {
|
|
"description": "A generic paginated response that follows a simple format.",
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"has_more": {
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
},
|
|
"url": {
|
|
"title": "Url",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"has_more"
|
|
],
|
|
"title": "PaginatedResponse",
|
|
"type": "object"
|
|
},
|
|
"ResponseGuardrailSpec": {
|
|
"description": "Specification for a guardrail to apply during response generation.",
|
|
"properties": {
|
|
"type": {
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
],
|
|
"title": "ResponseGuardrailSpec",
|
|
"type": "object"
|
|
},
|
|
"Session": {
|
|
"description": "A single session of an interaction with an Agentic System.",
|
|
"properties": {
|
|
"session_id": {
|
|
"title": "Session Id",
|
|
"type": "string"
|
|
},
|
|
"session_name": {
|
|
"title": "Session Name",
|
|
"type": "string"
|
|
},
|
|
"turns": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Turn"
|
|
},
|
|
"title": "Turns",
|
|
"type": "array"
|
|
},
|
|
"started_at": {
|
|
"format": "date-time",
|
|
"title": "Started At",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"session_id",
|
|
"session_name",
|
|
"turns",
|
|
"started_at"
|
|
],
|
|
"title": "Session",
|
|
"type": "object"
|
|
},
|
|
"ShieldCallStep": {
|
|
"description": "A shield call step in an agent turn.",
|
|
"properties": {
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"step_type": {
|
|
"const": "shield_call",
|
|
"default": "shield_call",
|
|
"title": "Step Type",
|
|
"type": "string"
|
|
},
|
|
"violation": {
|
|
"$ref": "#/components/schemas/SafetyViolation"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"violation"
|
|
],
|
|
"title": "ShieldCallStep",
|
|
"type": "object"
|
|
},
|
|
"ToolExecutionStep": {
|
|
"description": "A tool execution step in an agent turn.",
|
|
"properties": {
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
},
|
|
"step_id": {
|
|
"title": "Step Id",
|
|
"type": "string"
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"step_type": {
|
|
"const": "tool_execution",
|
|
"default": "tool_execution",
|
|
"title": "Step Type",
|
|
"type": "string"
|
|
},
|
|
"tool_calls": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
},
|
|
"title": "Tool Calls",
|
|
"type": "array"
|
|
},
|
|
"tool_responses": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolResponse"
|
|
},
|
|
"title": "Tool Responses",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"turn_id",
|
|
"step_id",
|
|
"tool_calls",
|
|
"tool_responses"
|
|
],
|
|
"title": "ToolExecutionStep",
|
|
"type": "object"
|
|
},
|
|
"ToolResponse": {
|
|
"description": "Response from a tool invocation.",
|
|
"properties": {
|
|
"call_id": {
|
|
"title": "Call Id",
|
|
"type": "string"
|
|
},
|
|
"tool_name": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltinTool"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Tool Name"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"call_id",
|
|
"tool_name",
|
|
"content"
|
|
],
|
|
"title": "ToolResponse",
|
|
"type": "object"
|
|
},
|
|
"ToolResponseMessage": {
|
|
"description": "A message representing the result of a tool invocation.",
|
|
"properties": {
|
|
"role": {
|
|
"const": "tool",
|
|
"default": "tool",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"call_id": {
|
|
"title": "Call Id",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
}
|
|
},
|
|
"required": [
|
|
"call_id",
|
|
"content"
|
|
],
|
|
"title": "ToolResponseMessage",
|
|
"type": "object"
|
|
},
|
|
"UserMessage": {
|
|
"description": "A message from the user in a chat conversation.",
|
|
"properties": {
|
|
"role": {
|
|
"const": "user",
|
|
"default": "user",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"context": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Context",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "UserMessage",
|
|
"type": "object"
|
|
},
|
|
"ListBatchesResponse": {
|
|
"description": "Response containing a list of batch objects.",
|
|
"properties": {
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"description": "List of batch objects",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Batch"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"first_id": {
|
|
"description": "ID of the first batch in the list",
|
|
"title": "First Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"last_id": {
|
|
"description": "ID of the last batch in the list",
|
|
"title": "Last Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"has_more": {
|
|
"default": false,
|
|
"description": "Whether there are more batches available",
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListBatchesResponse",
|
|
"type": "object"
|
|
},
|
|
"ConversationCreateRequest": {
|
|
"description": "Request body for creating a conversation.",
|
|
"properties": {
|
|
"items": {
|
|
"default": [],
|
|
"description": "Initial items to include in the conversation context. You may add up to 20 items at a time.",
|
|
"title": "Items",
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"function_call_output": "#/$defs/OpenAIResponseInputFunctionToolCallOutput",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_approval_response": "#/$defs/OpenAIResponseMCPApprovalResponse",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputFunctionToolCallOutput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 20,
|
|
"type": "array"
|
|
},
|
|
"metadata": {
|
|
"default": {},
|
|
"description": "Set of 16 key-value pairs that can be attached to an object. Useful for storing additional information",
|
|
"title": "Metadata",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"maxProperties": 16,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "ConversationCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"ConversationDeletedResource": {
|
|
"description": "Response for deleted conversation.",
|
|
"properties": {
|
|
"id": {
|
|
"description": "The deleted conversation identifier",
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"default": "conversation.deleted",
|
|
"description": "Object type",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"deleted": {
|
|
"default": true,
|
|
"description": "Whether the object was deleted",
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "ConversationDeletedResource",
|
|
"type": "object"
|
|
},
|
|
"ConversationItemCreateRequest": {
|
|
"description": "Request body for creating conversation items.",
|
|
"properties": {
|
|
"items": {
|
|
"description": "Items to include in the conversation context. You may add up to 20 items at a time.",
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"function_call_output": "#/$defs/OpenAIResponseInputFunctionToolCallOutput",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_approval_response": "#/$defs/OpenAIResponseMCPApprovalResponse",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputFunctionToolCallOutput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 20,
|
|
"title": "Items",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"items"
|
|
],
|
|
"title": "ConversationItemCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"ConversationItemDeletedResource": {
|
|
"description": "Response for deleted conversation item.",
|
|
"properties": {
|
|
"id": {
|
|
"description": "The deleted item identifier",
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"default": "conversation.item.deleted",
|
|
"description": "Object type",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"deleted": {
|
|
"default": true,
|
|
"description": "Whether the object was deleted",
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "ConversationItemDeletedResource",
|
|
"type": "object"
|
|
},
|
|
"ConversationUpdateRequest": {
|
|
"description": "Request body for updating a conversation.",
|
|
"properties": {
|
|
"metadata": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"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.",
|
|
"title": "Metadata",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"metadata"
|
|
],
|
|
"title": "ConversationUpdateRequest",
|
|
"type": "object"
|
|
},
|
|
"ExpiresAfter": {
|
|
"description": "Control expiration of uploaded files.\n\nParams:\n - anchor, must be \"created_at\"\n - seconds, must be int between 3600 and 2592000 (1 hour to 30 days)",
|
|
"properties": {
|
|
"anchor": {
|
|
"const": "created_at",
|
|
"title": "Anchor",
|
|
"type": "string"
|
|
},
|
|
"seconds": {
|
|
"maximum": 2592000,
|
|
"minimum": 3600,
|
|
"title": "Seconds",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"anchor",
|
|
"seconds"
|
|
],
|
|
"title": "ExpiresAfter",
|
|
"type": "object"
|
|
},
|
|
"ListOpenAIFileResponse": {
|
|
"description": "Response for listing files in OpenAI Files API.",
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIFileObject"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"has_more": {
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
},
|
|
"first_id": {
|
|
"title": "First Id",
|
|
"type": "string"
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"has_more",
|
|
"first_id",
|
|
"last_id"
|
|
],
|
|
"title": "ListOpenAIFileResponse",
|
|
"type": "object"
|
|
},
|
|
"OpenAIFileDeleteResponse": {
|
|
"description": "Response for deleting a file in OpenAI Files API.",
|
|
"properties": {
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "file",
|
|
"default": "file",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"deleted": {
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"deleted"
|
|
],
|
|
"title": "OpenAIFileDeleteResponse",
|
|
"type": "object"
|
|
},
|
|
"Bf16QuantizationConfig": {
|
|
"description": "Configuration for BFloat16 precision (typically no quantization).",
|
|
"properties": {
|
|
"type": {
|
|
"const": "bf16",
|
|
"default": "bf16",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Bf16QuantizationConfig",
|
|
"type": "object"
|
|
},
|
|
"ChatCompletionRequest": {
|
|
"properties": {
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string"
|
|
},
|
|
"messages": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"assistant": "#/$defs/CompletionMessage",
|
|
"system": "#/$defs/SystemMessage",
|
|
"tool": "#/$defs/ToolResponseMessage",
|
|
"user": "#/$defs/UserMessage"
|
|
},
|
|
"propertyName": "role"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SystemMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CompletionMessage"
|
|
}
|
|
]
|
|
},
|
|
"title": "Messages",
|
|
"type": "array"
|
|
},
|
|
"sampling_params": {
|
|
"$ref": "#/components/schemas/SamplingParams"
|
|
},
|
|
"tools": {
|
|
"title": "Tools",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolDefinition"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"tool_config": {
|
|
"$ref": "#/components/schemas/ToolConfig"
|
|
},
|
|
"response_format": {
|
|
"title": "Response Format",
|
|
"discriminator": {
|
|
"mapping": {
|
|
"grammar": "#/$defs/GrammarResponseFormat",
|
|
"json_schema": "#/$defs/JsonSchemaResponseFormat"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/JsonSchemaResponseFormat"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/GrammarResponseFormat"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/LogProbConfig",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"model",
|
|
"messages"
|
|
],
|
|
"title": "ChatCompletionRequest",
|
|
"type": "object"
|
|
},
|
|
"ChatCompletionResponse": {
|
|
"description": "Response from a chat completion request.",
|
|
"properties": {
|
|
"metrics": {
|
|
"title": "Metrics",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MetricInResponse"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"completion_message": {
|
|
"$ref": "#/components/schemas/CompletionMessage"
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TokenLogProbs"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"completion_message"
|
|
],
|
|
"title": "ChatCompletionResponse",
|
|
"type": "object"
|
|
},
|
|
"ChatCompletionResponseEvent": {
|
|
"description": "An event during chat completion generation.",
|
|
"properties": {
|
|
"event_type": {
|
|
"$ref": "#/components/schemas/ChatCompletionResponseEventType"
|
|
},
|
|
"delta": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageDelta",
|
|
"text": "#/$defs/TextDelta",
|
|
"tool_call": "#/$defs/ToolCallDelta"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TextDelta"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ImageDelta"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolCallDelta"
|
|
}
|
|
],
|
|
"title": "Delta"
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TokenLogProbs"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"stop_reason": {
|
|
"$ref": "#/components/schemas/StopReason",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"event_type",
|
|
"delta"
|
|
],
|
|
"title": "ChatCompletionResponseEvent",
|
|
"type": "object"
|
|
},
|
|
"ChatCompletionResponseStreamChunk": {
|
|
"description": "A chunk of a streamed chat completion response.",
|
|
"properties": {
|
|
"metrics": {
|
|
"title": "Metrics",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MetricInResponse"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"event": {
|
|
"$ref": "#/components/schemas/ChatCompletionResponseEvent"
|
|
}
|
|
},
|
|
"required": [
|
|
"event"
|
|
],
|
|
"title": "ChatCompletionResponseStreamChunk",
|
|
"type": "object"
|
|
},
|
|
"CompletionResponse": {
|
|
"description": "Response from a completion request.",
|
|
"properties": {
|
|
"metrics": {
|
|
"title": "Metrics",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MetricInResponse"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"title": "Content",
|
|
"type": "string"
|
|
},
|
|
"stop_reason": {
|
|
"$ref": "#/components/schemas/StopReason"
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TokenLogProbs"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"content",
|
|
"stop_reason"
|
|
],
|
|
"title": "CompletionResponse",
|
|
"type": "object"
|
|
},
|
|
"CompletionResponseStreamChunk": {
|
|
"description": "A chunk of a streamed completion response.",
|
|
"properties": {
|
|
"metrics": {
|
|
"title": "Metrics",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MetricInResponse"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"stop_reason": {
|
|
"$ref": "#/components/schemas/StopReason",
|
|
"nullable": true
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TokenLogProbs"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"delta"
|
|
],
|
|
"title": "CompletionResponseStreamChunk",
|
|
"type": "object"
|
|
},
|
|
"EmbeddingsResponse": {
|
|
"description": "Response containing generated embeddings.",
|
|
"properties": {
|
|
"embeddings": {
|
|
"items": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"title": "Embeddings",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"embeddings"
|
|
],
|
|
"title": "EmbeddingsResponse",
|
|
"type": "object"
|
|
},
|
|
"Fp8QuantizationConfig": {
|
|
"description": "Configuration for 8-bit floating point quantization.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "fp8_mixed",
|
|
"default": "fp8_mixed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Fp8QuantizationConfig",
|
|
"type": "object"
|
|
},
|
|
"Int4QuantizationConfig": {
|
|
"description": "Configuration for 4-bit integer quantization.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "int4_mixed",
|
|
"default": "int4_mixed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"scheme": {
|
|
"default": "int4_weight_int8_dynamic_activation",
|
|
"title": "Scheme",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Int4QuantizationConfig",
|
|
"type": "object"
|
|
},
|
|
"ListOpenAIChatCompletionResponse": {
|
|
"description": "Response from listing OpenAI-compatible chat completions.",
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAICompletionWithInputMessages"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"has_more": {
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
},
|
|
"first_id": {
|
|
"title": "First Id",
|
|
"type": "string"
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "list",
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"has_more",
|
|
"first_id",
|
|
"last_id"
|
|
],
|
|
"title": "ListOpenAIChatCompletionResponse",
|
|
"type": "object"
|
|
},
|
|
"OpenAIAssistantMessageParam": {
|
|
"description": "A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.",
|
|
"properties": {
|
|
"role": {
|
|
"const": "assistant",
|
|
"default": "assistant",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionContentPartTextParam"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionToolCall"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"title": "OpenAIAssistantMessageParam",
|
|
"type": "object"
|
|
},
|
|
"OpenAIChatCompletionChunk": {
|
|
"description": "Chunk from a streaming response to an OpenAI-compatible chat completion request.",
|
|
"properties": {
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"choices": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChunkChoice"
|
|
},
|
|
"title": "Choices",
|
|
"type": "array"
|
|
},
|
|
"object": {
|
|
"const": "chat.completion.chunk",
|
|
"default": "chat.completion.chunk",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"title": "Created",
|
|
"type": "integer"
|
|
},
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionUsage",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"choices",
|
|
"created",
|
|
"model"
|
|
],
|
|
"title": "OpenAIChatCompletionChunk",
|
|
"type": "object"
|
|
},
|
|
"OpenAIChoice": {
|
|
"description": "A choice from an OpenAI-compatible chat completion response.",
|
|
"properties": {
|
|
"message": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"assistant": "#/$defs/OpenAIAssistantMessageParam",
|
|
"developer": "#/$defs/OpenAIDeveloperMessageParam",
|
|
"system": "#/$defs/OpenAISystemMessageParam",
|
|
"tool": "#/$defs/OpenAIToolMessageParam",
|
|
"user": "#/$defs/OpenAIUserMessageParam"
|
|
},
|
|
"propertyName": "role"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIUserMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAISystemMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIAssistantMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIToolMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIDeveloperMessageParam"
|
|
}
|
|
],
|
|
"title": "Message"
|
|
},
|
|
"finish_reason": {
|
|
"title": "Finish Reason",
|
|
"type": "string"
|
|
},
|
|
"index": {
|
|
"title": "Index",
|
|
"type": "integer"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"finish_reason",
|
|
"index"
|
|
],
|
|
"title": "OpenAIChoice",
|
|
"type": "object"
|
|
},
|
|
"OpenAIChoiceDelta": {
|
|
"description": "A delta from an OpenAI-compatible chat completion streaming response.",
|
|
"properties": {
|
|
"content": {
|
|
"title": "Content",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"refusal": {
|
|
"title": "Refusal",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"role": {
|
|
"title": "Role",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tool_calls": {
|
|
"title": "Tool Calls",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionToolCall"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"reasoning_content": {
|
|
"title": "Reasoning Content",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"title": "OpenAIChoiceDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIChoiceLogprobs": {
|
|
"description": "The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response.",
|
|
"properties": {
|
|
"content": {
|
|
"title": "Content",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAITokenLogProb"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"refusal": {
|
|
"title": "Refusal",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAITokenLogProb"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"title": "OpenAIChoiceLogprobs",
|
|
"type": "object"
|
|
},
|
|
"OpenAIChunkChoice": {
|
|
"description": "A chunk choice from an OpenAI-compatible chat completion streaming response.",
|
|
"properties": {
|
|
"delta": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceDelta"
|
|
},
|
|
"finish_reason": {
|
|
"title": "Finish Reason",
|
|
"type": "string"
|
|
},
|
|
"index": {
|
|
"title": "Index",
|
|
"type": "integer"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"delta",
|
|
"finish_reason",
|
|
"index"
|
|
],
|
|
"title": "OpenAIChunkChoice",
|
|
"type": "object"
|
|
},
|
|
"OpenAICompletionChoice": {
|
|
"description": "A choice from an OpenAI-compatible completion response.",
|
|
"properties": {
|
|
"finish_reason": {
|
|
"title": "Finish Reason",
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"index": {
|
|
"title": "Index",
|
|
"type": "integer"
|
|
},
|
|
"logprobs": {
|
|
"$ref": "#/components/schemas/OpenAIChoiceLogprobs",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"finish_reason",
|
|
"text",
|
|
"index"
|
|
],
|
|
"title": "OpenAICompletionChoice",
|
|
"type": "object"
|
|
},
|
|
"OpenAICompletionLogprobs": {
|
|
"description": "The log probabilities for the tokens in the message from an OpenAI-compatible completion response.",
|
|
"properties": {
|
|
"text_offset": {
|
|
"title": "Text Offset",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"token_logprobs": {
|
|
"title": "Token Logprobs",
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"tokens": {
|
|
"title": "Tokens",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"top_logprobs": {
|
|
"title": "Top Logprobs",
|
|
"items": {
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"title": "OpenAICompletionLogprobs",
|
|
"type": "object"
|
|
},
|
|
"OpenAICompletionWithInputMessages": {
|
|
"properties": {
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"choices": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenAIChoice"
|
|
},
|
|
"title": "Choices",
|
|
"type": "array"
|
|
},
|
|
"object": {
|
|
"const": "chat.completion",
|
|
"default": "chat.completion",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"title": "Created",
|
|
"type": "integer"
|
|
},
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionUsage",
|
|
"nullable": true
|
|
},
|
|
"input_messages": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"assistant": "#/$defs/OpenAIAssistantMessageParam",
|
|
"developer": "#/$defs/OpenAIDeveloperMessageParam",
|
|
"system": "#/$defs/OpenAISystemMessageParam",
|
|
"tool": "#/$defs/OpenAIToolMessageParam",
|
|
"user": "#/$defs/OpenAIUserMessageParam"
|
|
},
|
|
"propertyName": "role"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIUserMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAISystemMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIAssistantMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIToolMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIDeveloperMessageParam"
|
|
}
|
|
]
|
|
},
|
|
"title": "Input Messages",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"choices",
|
|
"created",
|
|
"model",
|
|
"input_messages"
|
|
],
|
|
"title": "OpenAICompletionWithInputMessages",
|
|
"type": "object"
|
|
},
|
|
"OpenAIUserMessageParam": {
|
|
"description": "A message from the user in an OpenAI-compatible chat completion request.",
|
|
"properties": {
|
|
"role": {
|
|
"const": "user",
|
|
"default": "user",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file": "#/$defs/OpenAIFile",
|
|
"image_url": "#/$defs/OpenAIChatCompletionContentPartImageParam",
|
|
"text": "#/$defs/OpenAIChatCompletionContentPartTextParam"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionContentPartTextParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIChatCompletionContentPartImageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIFile"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "OpenAIUserMessageParam",
|
|
"type": "object"
|
|
},
|
|
"TokenLogProbs": {
|
|
"description": "Log probabilities for generated tokens.",
|
|
"properties": {
|
|
"logprobs_by_token": {
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"title": "Logprobs By Token",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"logprobs_by_token"
|
|
],
|
|
"title": "TokenLogProbs",
|
|
"type": "object"
|
|
},
|
|
"Checkpoint": {
|
|
"description": "Checkpoint created during training runs.",
|
|
"properties": {
|
|
"identifier": {
|
|
"title": "Identifier",
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"format": "date-time",
|
|
"title": "Created At",
|
|
"type": "string"
|
|
},
|
|
"epoch": {
|
|
"title": "Epoch",
|
|
"type": "integer"
|
|
},
|
|
"post_training_job_id": {
|
|
"title": "Post Training Job Id",
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"title": "Path",
|
|
"type": "string"
|
|
},
|
|
"training_metrics": {
|
|
"$ref": "#/components/schemas/PostTrainingMetric",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"identifier",
|
|
"created_at",
|
|
"epoch",
|
|
"post_training_job_id",
|
|
"path"
|
|
],
|
|
"title": "Checkpoint",
|
|
"type": "object"
|
|
},
|
|
"LoraFinetuningConfig": {
|
|
"description": "Configuration for Low-Rank Adaptation (LoRA) fine-tuning.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "LoRA",
|
|
"default": "LoRA",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"lora_attn_modules": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Lora Attn Modules",
|
|
"type": "array"
|
|
},
|
|
"apply_lora_to_mlp": {
|
|
"title": "Apply Lora To Mlp",
|
|
"type": "boolean"
|
|
},
|
|
"apply_lora_to_output": {
|
|
"title": "Apply Lora To Output",
|
|
"type": "boolean"
|
|
},
|
|
"rank": {
|
|
"title": "Rank",
|
|
"type": "integer"
|
|
},
|
|
"alpha": {
|
|
"title": "Alpha",
|
|
"type": "integer"
|
|
},
|
|
"use_dora": {
|
|
"default": false,
|
|
"title": "Use Dora",
|
|
"type": "boolean"
|
|
},
|
|
"quantize_base": {
|
|
"default": false,
|
|
"title": "Quantize Base",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"lora_attn_modules",
|
|
"apply_lora_to_mlp",
|
|
"apply_lora_to_output",
|
|
"rank",
|
|
"alpha"
|
|
],
|
|
"title": "LoraFinetuningConfig",
|
|
"type": "object"
|
|
},
|
|
"PostTrainingJobArtifactsResponse": {
|
|
"description": "Artifacts of a finetuning job.",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"title": "Job Uuid",
|
|
"type": "string"
|
|
},
|
|
"checkpoints": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Checkpoint"
|
|
},
|
|
"title": "Checkpoints",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"job_uuid"
|
|
],
|
|
"title": "PostTrainingJobArtifactsResponse",
|
|
"type": "object"
|
|
},
|
|
"PostTrainingJobLogStream": {
|
|
"description": "Stream of logs from a finetuning job.",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"title": "Job Uuid",
|
|
"type": "string"
|
|
},
|
|
"log_lines": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Log Lines",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"job_uuid",
|
|
"log_lines"
|
|
],
|
|
"title": "PostTrainingJobLogStream",
|
|
"type": "object"
|
|
},
|
|
"PostTrainingJobStatusResponse": {
|
|
"description": "Status of a finetuning job.",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"title": "Job Uuid",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/JobStatus"
|
|
},
|
|
"scheduled_at": {
|
|
"title": "Scheduled At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"started_at": {
|
|
"title": "Started At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"completed_at": {
|
|
"title": "Completed At",
|
|
"format": "date-time",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"resources_allocated": {
|
|
"title": "Resources Allocated",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"checkpoints": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Checkpoint"
|
|
},
|
|
"title": "Checkpoints",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"job_uuid",
|
|
"status"
|
|
],
|
|
"title": "PostTrainingJobStatusResponse",
|
|
"type": "object"
|
|
},
|
|
"PostTrainingRLHFRequest": {
|
|
"description": "Request to finetune a model using reinforcement learning from human feedback.",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"title": "Job Uuid",
|
|
"type": "string"
|
|
},
|
|
"finetuned_model": {
|
|
"$ref": "#/components/schemas/URL"
|
|
},
|
|
"dataset_id": {
|
|
"title": "Dataset Id",
|
|
"type": "string"
|
|
},
|
|
"validation_dataset_id": {
|
|
"title": "Validation Dataset Id",
|
|
"type": "string"
|
|
},
|
|
"algorithm": {
|
|
"$ref": "#/components/schemas/RLHFAlgorithm"
|
|
},
|
|
"algorithm_config": {
|
|
"$ref": "#/components/schemas/DPOAlignmentConfig"
|
|
},
|
|
"optimizer_config": {
|
|
"$ref": "#/components/schemas/OptimizerConfig"
|
|
},
|
|
"training_config": {
|
|
"$ref": "#/components/schemas/TrainingConfig"
|
|
},
|
|
"hyperparam_search_config": {
|
|
"additionalProperties": true,
|
|
"title": "Hyperparam Search Config",
|
|
"type": "object"
|
|
},
|
|
"logger_config": {
|
|
"additionalProperties": true,
|
|
"title": "Logger Config",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"job_uuid",
|
|
"finetuned_model",
|
|
"dataset_id",
|
|
"validation_dataset_id",
|
|
"algorithm",
|
|
"algorithm_config",
|
|
"optimizer_config",
|
|
"training_config",
|
|
"hyperparam_search_config",
|
|
"logger_config"
|
|
],
|
|
"title": "PostTrainingRLHFRequest",
|
|
"type": "object"
|
|
},
|
|
"QATFinetuningConfig": {
|
|
"description": "Configuration for Quantization-Aware Training (QAT) fine-tuning.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "QAT",
|
|
"default": "QAT",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"quantizer_name": {
|
|
"title": "Quantizer Name",
|
|
"type": "string"
|
|
},
|
|
"group_size": {
|
|
"title": "Group Size",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"quantizer_name",
|
|
"group_size"
|
|
],
|
|
"title": "QATFinetuningConfig",
|
|
"type": "object"
|
|
},
|
|
"ScoringFn": {
|
|
"description": "A scoring function resource for evaluating model outputs.",
|
|
"properties": {
|
|
"identifier": {
|
|
"description": "Unique identifier for this resource in llama stack",
|
|
"title": "Identifier",
|
|
"type": "string"
|
|
},
|
|
"provider_resource_id": {
|
|
"description": "Unique identifier for this resource in the provider",
|
|
"title": "Provider Resource Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"provider_id": {
|
|
"description": "ID of the provider that owns this resource",
|
|
"title": "Provider Id",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "scoring_function",
|
|
"default": "scoring_function",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"description": "Any additional metadata for this definition",
|
|
"title": "Metadata",
|
|
"type": "object"
|
|
},
|
|
"return_type": {
|
|
"description": "The return type of the deterministic function",
|
|
"discriminator": {
|
|
"mapping": {
|
|
"agent_turn_input": "#/$defs/AgentTurnInputType",
|
|
"array": "#/$defs/ArrayType",
|
|
"boolean": "#/$defs/BooleanType",
|
|
"chat_completion_input": "#/$defs/ChatCompletionInputType",
|
|
"completion_input": "#/$defs/CompletionInputType",
|
|
"json": "#/$defs/JsonType",
|
|
"number": "#/$defs/NumberType",
|
|
"object": "#/$defs/ObjectType",
|
|
"string": "#/$defs/StringType",
|
|
"union": "#/$defs/UnionType"
|
|
},
|
|
"propertyName": "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"
|
|
},
|
|
"params": {
|
|
"description": "The parameters for the scoring function for benchmark eval, these can be overridden for app eval",
|
|
"title": "Params",
|
|
"discriminator": {
|
|
"mapping": {
|
|
"basic": "#/$defs/BasicScoringFnParams",
|
|
"llm_as_judge": "#/$defs/LLMAsJudgeScoringFnParams",
|
|
"regex_parser": "#/$defs/RegexParserScoringFnParams"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LLMAsJudgeScoringFnParams"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/RegexParserScoringFnParams"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/BasicScoringFnParams"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"identifier",
|
|
"provider_id",
|
|
"return_type"
|
|
],
|
|
"title": "ScoringFn",
|
|
"type": "object"
|
|
},
|
|
"SyntheticDataGenerationRequest": {
|
|
"description": "Request to generate synthetic data. A small batch of prompts and a filtering function",
|
|
"properties": {
|
|
"dialogs": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"assistant": "#/$defs/CompletionMessage",
|
|
"system": "#/$defs/SystemMessage",
|
|
"tool": "#/$defs/ToolResponseMessage",
|
|
"user": "#/$defs/UserMessage"
|
|
},
|
|
"propertyName": "role"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/SystemMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CompletionMessage"
|
|
}
|
|
]
|
|
},
|
|
"title": "Dialogs",
|
|
"type": "array"
|
|
},
|
|
"filtering_function": {
|
|
"$ref": "#/components/schemas/FilteringFunction",
|
|
"default": "none"
|
|
},
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"dialogs"
|
|
],
|
|
"title": "SyntheticDataGenerationRequest",
|
|
"type": "object"
|
|
},
|
|
"SyntheticDataGenerationResponse": {
|
|
"description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.",
|
|
"properties": {
|
|
"synthetic_data": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Synthetic Data",
|
|
"type": "array"
|
|
},
|
|
"statistics": {
|
|
"title": "Statistics",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"synthetic_data"
|
|
],
|
|
"title": "SyntheticDataGenerationResponse",
|
|
"type": "object"
|
|
},
|
|
"ListToolDefsResponse": {
|
|
"description": "Response containing a list of tool definitions.",
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/ToolDef"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "ListToolDefsResponse",
|
|
"type": "object"
|
|
},
|
|
"RAGDocument": {
|
|
"description": "A document to be used for document ingestion in the RAG Tool.",
|
|
"properties": {
|
|
"document_id": {
|
|
"title": "Document Id",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"mime_type": {
|
|
"title": "Mime Type",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"title": "Metadata",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"document_id",
|
|
"content"
|
|
],
|
|
"title": "RAGDocument",
|
|
"type": "object"
|
|
},
|
|
"ToolGroupInput": {
|
|
"description": "Input data for registering a tool group.",
|
|
"properties": {
|
|
"toolgroup_id": {
|
|
"title": "Toolgroup Id",
|
|
"type": "string"
|
|
},
|
|
"provider_id": {
|
|
"title": "Provider Id",
|
|
"type": "string"
|
|
},
|
|
"args": {
|
|
"title": "Args",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"mcp_endpoint": {
|
|
"$ref": "#/components/schemas/URL",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"toolgroup_id",
|
|
"provider_id"
|
|
],
|
|
"title": "ToolGroupInput",
|
|
"type": "object"
|
|
},
|
|
"Chunk": {
|
|
"description": "A chunk of content that can be inserted into a vector database.",
|
|
"properties": {
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"chunk_id": {
|
|
"title": "Chunk Id",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"title": "Metadata",
|
|
"type": "object"
|
|
},
|
|
"embedding": {
|
|
"title": "Embedding",
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"chunk_metadata": {
|
|
"$ref": "#/components/schemas/ChunkMetadata",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"content",
|
|
"chunk_id"
|
|
],
|
|
"title": "Chunk",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreCreateRequest": {
|
|
"description": "Request to create a vector store.",
|
|
"properties": {
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"file_ids": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "File Ids",
|
|
"type": "array"
|
|
},
|
|
"expires_after": {
|
|
"title": "Expires After",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"chunking_strategy": {
|
|
"title": "Chunking Strategy",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": true,
|
|
"title": "Metadata",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "VectorStoreCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreDeleteResponse": {
|
|
"description": "Response from deleting a vector store.",
|
|
"properties": {
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"default": "vector_store.deleted",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"deleted": {
|
|
"default": true,
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "VectorStoreDeleteResponse",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreFileContentsResponse": {
|
|
"description": "Response from retrieving the contents of a vector store file.",
|
|
"properties": {
|
|
"file_id": {
|
|
"title": "File Id",
|
|
"type": "string"
|
|
},
|
|
"filename": {
|
|
"title": "Filename",
|
|
"type": "string"
|
|
},
|
|
"attributes": {
|
|
"additionalProperties": true,
|
|
"title": "Attributes",
|
|
"type": "object"
|
|
},
|
|
"content": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/VectorStoreContent"
|
|
},
|
|
"title": "Content",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"file_id",
|
|
"filename",
|
|
"attributes",
|
|
"content"
|
|
],
|
|
"title": "VectorStoreFileContentsResponse",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreFileDeleteResponse": {
|
|
"description": "Response from deleting a vector store file.",
|
|
"properties": {
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"default": "vector_store.file.deleted",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"deleted": {
|
|
"default": true,
|
|
"title": "Deleted",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "VectorStoreFileDeleteResponse",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreFilesListInBatchResponse": {
|
|
"description": "Response from listing files in a vector store file batch.",
|
|
"properties": {
|
|
"object": {
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/VectorStoreFileObject"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"first_id": {
|
|
"title": "First Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"has_more": {
|
|
"default": false,
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "VectorStoreFilesListInBatchResponse",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreListFilesResponse": {
|
|
"description": "Response from listing files in a vector store.",
|
|
"properties": {
|
|
"object": {
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/VectorStoreFileObject"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"first_id": {
|
|
"title": "First Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"has_more": {
|
|
"default": false,
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "VectorStoreListFilesResponse",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreListResponse": {
|
|
"description": "Response from listing vector stores.",
|
|
"properties": {
|
|
"object": {
|
|
"default": "list",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/VectorStoreObject"
|
|
},
|
|
"title": "Data",
|
|
"type": "array"
|
|
},
|
|
"first_id": {
|
|
"title": "First Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"last_id": {
|
|
"title": "Last Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"has_more": {
|
|
"default": false,
|
|
"title": "Has More",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "VectorStoreListResponse",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreModifyRequest": {
|
|
"description": "Request to modify a vector store.",
|
|
"properties": {
|
|
"name": {
|
|
"title": "Name",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"expires_after": {
|
|
"title": "Expires After",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"title": "VectorStoreModifyRequest",
|
|
"type": "object"
|
|
},
|
|
"VectorStoreSearchRequest": {
|
|
"description": "Request to search a vector store.",
|
|
"properties": {
|
|
"query": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Query"
|
|
},
|
|
"filters": {
|
|
"title": "Filters",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"max_num_results": {
|
|
"default": 10,
|
|
"title": "Max Num Results",
|
|
"type": "integer"
|
|
},
|
|
"ranking_options": {
|
|
"title": "Ranking Options",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"rewrite_query": {
|
|
"default": false,
|
|
"title": "Rewrite Query",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"query"
|
|
],
|
|
"title": "VectorStoreSearchRequest",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseContentPartOutputText": {
|
|
"description": "Text content within a streamed response part.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "output_text",
|
|
"default": "output_text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"annotations": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"container_file_citation": "#/$defs/OpenAIResponseAnnotationContainerFileCitation",
|
|
"file_citation": "#/$defs/OpenAIResponseAnnotationFileCitation",
|
|
"file_path": "#/$defs/OpenAIResponseAnnotationFilePath",
|
|
"url_citation": "#/$defs/OpenAIResponseAnnotationCitation"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationFileCitation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationCitation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationContainerFileCitation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationFilePath"
|
|
}
|
|
]
|
|
},
|
|
"title": "Annotations",
|
|
"type": "array"
|
|
},
|
|
"logprobs": {
|
|
"title": "Logprobs",
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "OpenAIResponseContentPartOutputText",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseContentPartReasoningSummary": {
|
|
"description": "Reasoning summary part in a streamed response.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "summary_text",
|
|
"default": "summary_text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "OpenAIResponseContentPartReasoningSummary",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseContentPartReasoningText": {
|
|
"description": "Reasoning text emitted as part of a streamed response.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "reasoning_text",
|
|
"default": "reasoning_text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "OpenAIResponseContentPartReasoningText",
|
|
"type": "object"
|
|
},
|
|
"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.",
|
|
"properties": {
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"input_file": "#/$defs/OpenAIResponseInputMessageContentFile",
|
|
"input_image": "#/$defs/OpenAIResponseInputMessageContentImage",
|
|
"input_text": "#/$defs/OpenAIResponseInputMessageContentText"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputMessageContentText"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputMessageContentImage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputMessageContentFile"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"output_text": "#/$defs/OpenAIResponseOutputMessageContentOutputText",
|
|
"refusal": "#/$defs/OpenAIResponseContentPartRefusal"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageContentOutputText"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"role": {
|
|
"anyOf": [
|
|
{
|
|
"const": "system",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"const": "developer",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"const": "user",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"const": "assistant",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Role"
|
|
},
|
|
"type": {
|
|
"const": "message",
|
|
"default": "message",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"content",
|
|
"role"
|
|
],
|
|
"title": "OpenAIResponseMessage",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseCompleted": {
|
|
"description": "Streaming event indicating a response has been completed.",
|
|
"properties": {
|
|
"response": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
},
|
|
"type": {
|
|
"const": "response.completed",
|
|
"default": "response.completed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseCompleted",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseContentPartAdded": {
|
|
"description": "Streaming event for when a new content part is added to a response item.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"response_id": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"part": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"output_text": "#/$defs/OpenAIResponseContentPartOutputText",
|
|
"reasoning_text": "#/$defs/OpenAIResponseContentPartReasoningText",
|
|
"refusal": "#/$defs/OpenAIResponseContentPartRefusal"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartOutputText"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
|
}
|
|
],
|
|
"title": "Part"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.content_part.added",
|
|
"default": "response.content_part.added",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"response_id",
|
|
"item_id",
|
|
"output_index",
|
|
"part",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseContentPartAdded",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseContentPartDone": {
|
|
"description": "Streaming event for when a content part is completed.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"response_id": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"part": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"output_text": "#/$defs/OpenAIResponseContentPartOutputText",
|
|
"reasoning_text": "#/$defs/OpenAIResponseContentPartReasoningText",
|
|
"refusal": "#/$defs/OpenAIResponseContentPartRefusal"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartOutputText"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
|
}
|
|
],
|
|
"title": "Part"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.content_part.done",
|
|
"default": "response.content_part.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"response_id",
|
|
"item_id",
|
|
"output_index",
|
|
"part",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseContentPartDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseCreated": {
|
|
"description": "Streaming event indicating a new response has been created.",
|
|
"properties": {
|
|
"response": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
},
|
|
"type": {
|
|
"const": "response.created",
|
|
"default": "response.created",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseCreated",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseFailed": {
|
|
"description": "Streaming event emitted when a response fails.",
|
|
"properties": {
|
|
"response": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.failed",
|
|
"default": "response.failed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseFailed",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseFileSearchCallCompleted": {
|
|
"description": "Streaming event for completed file search calls.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.file_search_call.completed",
|
|
"default": "response.file_search_call.completed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseFileSearchCallCompleted",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseFileSearchCallInProgress": {
|
|
"description": "Streaming event for file search calls in progress.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.file_search_call.in_progress",
|
|
"default": "response.file_search_call.in_progress",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseFileSearchCallInProgress",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseFileSearchCallSearching": {
|
|
"description": "Streaming event for file search currently searching.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.file_search_call.searching",
|
|
"default": "response.file_search_call.searching",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseFileSearchCallSearching",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": {
|
|
"description": "Streaming event for incremental function call argument updates.",
|
|
"properties": {
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.function_call_arguments.delta",
|
|
"default": "response.function_call_arguments.delta",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"delta",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone": {
|
|
"description": "Streaming event for when function call arguments are completed.",
|
|
"properties": {
|
|
"arguments": {
|
|
"title": "Arguments",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.function_call_arguments.done",
|
|
"default": "response.function_call_arguments.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"arguments",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseInProgress": {
|
|
"description": "Streaming event indicating the response remains in progress.",
|
|
"properties": {
|
|
"response": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.in_progress",
|
|
"default": "response.in_progress",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseInProgress",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseIncomplete": {
|
|
"description": "Streaming event emitted when a response ends in an incomplete state.",
|
|
"properties": {
|
|
"response": {
|
|
"$ref": "#/components/schemas/OpenAIResponseObject"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.incomplete",
|
|
"default": "response.incomplete",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseIncomplete",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": {
|
|
"properties": {
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_call.arguments.delta",
|
|
"default": "response.mcp_call.arguments.delta",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"delta",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDone": {
|
|
"properties": {
|
|
"arguments": {
|
|
"title": "Arguments",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_call.arguments.done",
|
|
"default": "response.mcp_call.arguments.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"arguments",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpCallArgumentsDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpCallCompleted": {
|
|
"description": "Streaming event for completed MCP calls.",
|
|
"properties": {
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_call.completed",
|
|
"default": "response.mcp_call.completed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpCallCompleted",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpCallFailed": {
|
|
"description": "Streaming event for failed MCP calls.",
|
|
"properties": {
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_call.failed",
|
|
"default": "response.mcp_call.failed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpCallFailed",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpCallInProgress": {
|
|
"description": "Streaming event for MCP calls in progress.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_call.in_progress",
|
|
"default": "response.mcp_call.in_progress",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpCallInProgress",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpListToolsCompleted": {
|
|
"properties": {
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_list_tools.completed",
|
|
"default": "response.mcp_list_tools.completed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpListToolsCompleted",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpListToolsFailed": {
|
|
"properties": {
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_list_tools.failed",
|
|
"default": "response.mcp_list_tools.failed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpListToolsFailed",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseMcpListToolsInProgress": {
|
|
"properties": {
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.mcp_list_tools.in_progress",
|
|
"default": "response.mcp_list_tools.in_progress",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseMcpListToolsInProgress",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseOutputItemAdded": {
|
|
"description": "Streaming event for when a new output item is added to the response.",
|
|
"properties": {
|
|
"response_id": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
}
|
|
],
|
|
"title": "Item"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.output_item.added",
|
|
"default": "response.output_item.added",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response_id",
|
|
"item",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseOutputItemAdded",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseOutputItemDone": {
|
|
"description": "Streaming event for when an output item is completed.",
|
|
"properties": {
|
|
"response_id": {
|
|
"title": "Response Id",
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
}
|
|
],
|
|
"title": "Item"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.output_item.done",
|
|
"default": "response.output_item.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"response_id",
|
|
"item",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseOutputItemDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded": {
|
|
"description": "Streaming event for when an annotation is added to output text.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"annotation_index": {
|
|
"title": "Annotation Index",
|
|
"type": "integer"
|
|
},
|
|
"annotation": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"container_file_citation": "#/$defs/OpenAIResponseAnnotationContainerFileCitation",
|
|
"file_citation": "#/$defs/OpenAIResponseAnnotationFileCitation",
|
|
"file_path": "#/$defs/OpenAIResponseAnnotationFilePath",
|
|
"url_citation": "#/$defs/OpenAIResponseAnnotationCitation"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationFileCitation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationCitation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationContainerFileCitation"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseAnnotationFilePath"
|
|
}
|
|
],
|
|
"title": "Annotation"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.output_text.annotation.added",
|
|
"default": "response.output_text.annotation.added",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"content_index",
|
|
"annotation_index",
|
|
"annotation",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseOutputTextDelta": {
|
|
"description": "Streaming event for incremental text content updates.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.output_text.delta",
|
|
"default": "response.output_text.delta",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"delta",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseOutputTextDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseOutputTextDone": {
|
|
"description": "Streaming event for when text output is completed.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.output_text.done",
|
|
"default": "response.output_text.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"text",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseOutputTextDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded": {
|
|
"description": "Streaming event for when a new reasoning summary part is added.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"part": {
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningSummary"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"summary_index": {
|
|
"title": "Summary Index",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.reasoning_summary_part.added",
|
|
"default": "response.reasoning_summary_part.added",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"part",
|
|
"sequence_number",
|
|
"summary_index"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseReasoningSummaryPartDone": {
|
|
"description": "Streaming event for when a reasoning summary part is completed.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"part": {
|
|
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningSummary"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"summary_index": {
|
|
"title": "Summary Index",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.reasoning_summary_part.done",
|
|
"default": "response.reasoning_summary_part.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"part",
|
|
"sequence_number",
|
|
"summary_index"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseReasoningSummaryPartDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta": {
|
|
"description": "Streaming event for incremental reasoning summary text updates.",
|
|
"properties": {
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"summary_index": {
|
|
"title": "Summary Index",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.reasoning_summary_text.delta",
|
|
"default": "response.reasoning_summary_text.delta",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"delta",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number",
|
|
"summary_index"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseReasoningSummaryTextDone": {
|
|
"description": "Streaming event for when reasoning summary text is completed.",
|
|
"properties": {
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"summary_index": {
|
|
"title": "Summary Index",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.reasoning_summary_text.done",
|
|
"default": "response.reasoning_summary_text.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number",
|
|
"summary_index"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseReasoningSummaryTextDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseReasoningTextDelta": {
|
|
"description": "Streaming event for incremental reasoning text updates.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.reasoning_text.delta",
|
|
"default": "response.reasoning_text.delta",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"delta",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseReasoningTextDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseReasoningTextDone": {
|
|
"description": "Streaming event for when reasoning text is completed.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.reasoning_text.done",
|
|
"default": "response.reasoning_text.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"text",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseReasoningTextDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseRefusalDelta": {
|
|
"description": "Streaming event for incremental refusal text updates.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"delta": {
|
|
"title": "Delta",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.refusal.delta",
|
|
"default": "response.refusal.delta",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"delta",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseRefusalDelta",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseRefusalDone": {
|
|
"description": "Streaming event for when refusal text is completed.",
|
|
"properties": {
|
|
"content_index": {
|
|
"title": "Content Index",
|
|
"type": "integer"
|
|
},
|
|
"refusal": {
|
|
"title": "Refusal",
|
|
"type": "string"
|
|
},
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.refusal.done",
|
|
"default": "response.refusal.done",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content_index",
|
|
"refusal",
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseRefusalDone",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseWebSearchCallCompleted": {
|
|
"description": "Streaming event for completed web search calls.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.web_search_call.completed",
|
|
"default": "response.web_search_call.completed",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseWebSearchCallCompleted",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseWebSearchCallInProgress": {
|
|
"description": "Streaming event for web search calls in progress.",
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.web_search_call.in_progress",
|
|
"default": "response.web_search_call.in_progress",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseWebSearchCallInProgress",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectStreamResponseWebSearchCallSearching": {
|
|
"properties": {
|
|
"item_id": {
|
|
"title": "Item Id",
|
|
"type": "string"
|
|
},
|
|
"output_index": {
|
|
"title": "Output Index",
|
|
"type": "integer"
|
|
},
|
|
"sequence_number": {
|
|
"title": "Sequence Number",
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "response.web_search_call.searching",
|
|
"default": "response.web_search_call.searching",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id",
|
|
"output_index",
|
|
"sequence_number"
|
|
],
|
|
"title": "OpenAIResponseObjectStreamResponseWebSearchCallSearching",
|
|
"type": "object"
|
|
},
|
|
"OpenAIResponseObjectWithInput": {
|
|
"description": "OpenAI response object extended with input context information.",
|
|
"properties": {
|
|
"created_at": {
|
|
"title": "Created At",
|
|
"type": "integer"
|
|
},
|
|
"error": {
|
|
"$ref": "#/components/schemas/OpenAIResponseError",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"model": {
|
|
"title": "Model",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "response",
|
|
"default": "response",
|
|
"title": "Object",
|
|
"type": "string"
|
|
},
|
|
"output": {
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
}
|
|
]
|
|
},
|
|
"title": "Output",
|
|
"type": "array"
|
|
},
|
|
"parallel_tool_calls": {
|
|
"default": false,
|
|
"title": "Parallel Tool Calls",
|
|
"type": "boolean"
|
|
},
|
|
"previous_response_id": {
|
|
"title": "Previous Response Id",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"prompt": {
|
|
"$ref": "#/components/schemas/OpenAIResponsePrompt",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"temperature": {
|
|
"title": "Temperature",
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"text": {
|
|
"$ref": "#/components/schemas/OpenAIResponseText",
|
|
"default": {
|
|
"format": {
|
|
"type": "text"
|
|
}
|
|
}
|
|
},
|
|
"top_p": {
|
|
"title": "Top P",
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"tools": {
|
|
"title": "Tools",
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search": "#/$defs/OpenAIResponseInputToolFileSearch",
|
|
"function": "#/$defs/OpenAIResponseInputToolFunction",
|
|
"mcp": "#/$defs/OpenAIResponseToolMCP",
|
|
"web_search": "#/$defs/OpenAIResponseInputToolWebSearch",
|
|
"web_search_preview": "#/$defs/OpenAIResponseInputToolWebSearch",
|
|
"web_search_preview_2025_03_11": "#/$defs/OpenAIResponseInputToolWebSearch"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolWebSearch"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolFileSearch"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputToolFunction"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseToolMCP"
|
|
}
|
|
]
|
|
},
|
|
"type": "array",
|
|
"nullable": true
|
|
},
|
|
"truncation": {
|
|
"title": "Truncation",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"usage": {
|
|
"$ref": "#/components/schemas/OpenAIResponseUsage",
|
|
"nullable": true
|
|
},
|
|
"instructions": {
|
|
"title": "Instructions",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"input": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"file_search_call": "#/$defs/OpenAIResponseOutputMessageFileSearchToolCall",
|
|
"function_call": "#/$defs/OpenAIResponseOutputMessageFunctionToolCall",
|
|
"mcp_approval_request": "#/$defs/OpenAIResponseMCPApprovalRequest",
|
|
"mcp_call": "#/$defs/OpenAIResponseOutputMessageMCPCall",
|
|
"mcp_list_tools": "#/$defs/OpenAIResponseOutputMessageMCPListTools",
|
|
"message": "#/$defs/OpenAIResponseMessage",
|
|
"web_search_call": "#/$defs/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPCall"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseOutputMessageMCPListTools"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalRequest"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseInputFunctionToolCallOutput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMCPApprovalResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIResponseMessage"
|
|
}
|
|
]
|
|
},
|
|
"title": "Input",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"created_at",
|
|
"id",
|
|
"model",
|
|
"output",
|
|
"status",
|
|
"input"
|
|
],
|
|
"title": "OpenAIResponseObjectWithInput",
|
|
"type": "object"
|
|
},
|
|
"ImageContentItem": {
|
|
"description": "A image content item",
|
|
"properties": {
|
|
"type": {
|
|
"const": "image",
|
|
"default": "image",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"$ref": "#/components/schemas/_URLOrData"
|
|
}
|
|
},
|
|
"required": [
|
|
"image"
|
|
],
|
|
"title": "ImageContentItem",
|
|
"type": "object"
|
|
},
|
|
"ImageDelta": {
|
|
"description": "An image content delta for streaming responses.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "image",
|
|
"default": "image",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"format": "binary",
|
|
"title": "Image",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"image"
|
|
],
|
|
"title": "ImageDelta",
|
|
"type": "object"
|
|
},
|
|
"TextDelta": {
|
|
"description": "A text content delta for streaming responses.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "text",
|
|
"default": "text",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"title": "Text",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text"
|
|
],
|
|
"title": "TextDelta",
|
|
"type": "object"
|
|
},
|
|
"ToolCallDelta": {
|
|
"description": "A tool call content delta for streaming responses.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "tool_call",
|
|
"default": "tool_call",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"tool_call": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ToolCall"
|
|
}
|
|
],
|
|
"title": "Tool Call"
|
|
},
|
|
"parse_status": {
|
|
"$ref": "#/components/schemas/ToolCallParseStatus"
|
|
}
|
|
},
|
|
"required": [
|
|
"tool_call",
|
|
"parse_status"
|
|
],
|
|
"title": "ToolCallDelta",
|
|
"type": "object"
|
|
},
|
|
"PostTrainingMetric": {
|
|
"description": "Training metrics captured during post-training jobs.",
|
|
"properties": {
|
|
"epoch": {
|
|
"title": "Epoch",
|
|
"type": "integer"
|
|
},
|
|
"train_loss": {
|
|
"title": "Train Loss",
|
|
"type": "number"
|
|
},
|
|
"validation_loss": {
|
|
"title": "Validation Loss",
|
|
"type": "number"
|
|
},
|
|
"perplexity": {
|
|
"title": "Perplexity",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"epoch",
|
|
"train_loss",
|
|
"validation_loss",
|
|
"perplexity"
|
|
],
|
|
"title": "PostTrainingMetric",
|
|
"type": "object"
|
|
},
|
|
"DialogType": {
|
|
"description": "Parameter type for dialog data with semantic output labels.",
|
|
"properties": {
|
|
"type": {
|
|
"const": "dialog",
|
|
"default": "dialog",
|
|
"title": "Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "DialogType",
|
|
"type": "object"
|
|
},
|
|
"ConversationMessage": {
|
|
"description": "OpenAI-compatible message item for conversations.",
|
|
"properties": {
|
|
"id": {
|
|
"description": "unique identifier for this message",
|
|
"title": "Id",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "message content",
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"title": "Content",
|
|
"type": "array"
|
|
},
|
|
"role": {
|
|
"description": "message role",
|
|
"title": "Role",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "message status",
|
|
"title": "Status",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "message",
|
|
"default": "message",
|
|
"title": "Type",
|
|
"type": "string"
|
|
},
|
|
"object": {
|
|
"const": "message",
|
|
"default": "message",
|
|
"title": "Object",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"content",
|
|
"role",
|
|
"status"
|
|
],
|
|
"title": "ConversationMessage",
|
|
"type": "object"
|
|
},
|
|
"_agents_agent_id_session_Request": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"title": "Agent Id",
|
|
"type": "string"
|
|
},
|
|
"session_name": {
|
|
"title": "Session Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"agent_id",
|
|
"session_name"
|
|
],
|
|
"title": "_agents_agent_id_session_Request",
|
|
"type": "object"
|
|
},
|
|
"_agents_agent_id_session_session_id_turn_Request": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"title": "Agent Id",
|
|
"type": "string"
|
|
},
|
|
"session_id": {
|
|
"title": "Session Id",
|
|
"type": "string"
|
|
},
|
|
"messages": {
|
|
"$ref": "#/components/schemas/UserMessage"
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
},
|
|
"documents": {
|
|
"$ref": "#/components/schemas/Document"
|
|
},
|
|
"toolgroups": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgentToolGroupWithArgs"
|
|
}
|
|
],
|
|
"title": "Toolgroups"
|
|
},
|
|
"tool_config": {
|
|
"$ref": "#/components/schemas/ToolConfig"
|
|
}
|
|
},
|
|
"required": [
|
|
"agent_id",
|
|
"session_id",
|
|
"messages",
|
|
"documents",
|
|
"toolgroups",
|
|
"tool_config"
|
|
],
|
|
"title": "_agents_agent_id_session_session_id_turn_Request",
|
|
"type": "object"
|
|
},
|
|
"_agents_agent_id_session_session_id_turn_turn_id_resume_Request": {
|
|
"properties": {
|
|
"agent_id": {
|
|
"title": "Agent Id",
|
|
"type": "string"
|
|
},
|
|
"session_id": {
|
|
"title": "Session Id",
|
|
"type": "string"
|
|
},
|
|
"turn_id": {
|
|
"title": "Turn Id",
|
|
"type": "string"
|
|
},
|
|
"tool_responses": {
|
|
"$ref": "#/components/schemas/ToolResponse"
|
|
},
|
|
"stream": {
|
|
"default": false,
|
|
"title": "Stream",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"agent_id",
|
|
"session_id",
|
|
"turn_id",
|
|
"tool_responses"
|
|
],
|
|
"title": "_agents_agent_id_session_session_id_turn_turn_id_resume_Request",
|
|
"type": "object"
|
|
},
|
|
"_safety_run_shield_Request": {
|
|
"properties": {
|
|
"shield_id": {
|
|
"title": "Shield Id",
|
|
"type": "string"
|
|
},
|
|
"messages": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIUserMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAISystemMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIAssistantMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIToolMessageParam"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/OpenAIDeveloperMessageParam"
|
|
}
|
|
],
|
|
"title": "Messages"
|
|
},
|
|
"params": {
|
|
"title": "Params",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"shield_id",
|
|
"messages",
|
|
"params"
|
|
],
|
|
"title": "_safety_run_shield_Request",
|
|
"type": "object"
|
|
},
|
|
"_datasets_Request": {
|
|
"properties": {
|
|
"purpose": {
|
|
"$ref": "#/components/schemas/DatasetPurpose"
|
|
},
|
|
"metadata": {
|
|
"title": "Metadata",
|
|
"type": "string"
|
|
},
|
|
"dataset_id": {
|
|
"title": "Dataset Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"purpose",
|
|
"metadata",
|
|
"dataset_id"
|
|
],
|
|
"title": "_datasets_Request",
|
|
"type": "object"
|
|
},
|
|
"Attachment": {
|
|
"description": "An attachment to an agent turn.",
|
|
"properties": {
|
|
"content": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"items": {
|
|
"discriminator": {
|
|
"mapping": {
|
|
"image": "#/$defs/ImageContentItem",
|
|
"text": "#/$defs/TextContentItem"
|
|
},
|
|
"propertyName": "type"
|
|
},
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImageContentItem"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/TextContentItem"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
],
|
|
"title": "Content"
|
|
},
|
|
"mime_type": {
|
|
"title": "Mime Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"content",
|
|
"mime_type"
|
|
],
|
|
"title": "Attachment",
|
|
"type": "object"
|
|
},
|
|
"StepType": {
|
|
"description": "Type of the step in an agent turn.",
|
|
"enum": [
|
|
"inference",
|
|
"tool_execution",
|
|
"shield_call",
|
|
"memory_retrieval"
|
|
],
|
|
"title": "StepType",
|
|
"type": "string"
|
|
},
|
|
"ToolCallParseStatus": {
|
|
"description": "Status of tool call parsing during streaming.",
|
|
"enum": [
|
|
"started",
|
|
"in_progress",
|
|
"failed",
|
|
"succeeded"
|
|
],
|
|
"title": "ToolCallParseStatus",
|
|
"type": "string"
|
|
},
|
|
"LogProbConfig": {
|
|
"description": ":param top_k: How many tokens (for each position) to return log probabilities for.",
|
|
"properties": {
|
|
"top_k": {
|
|
"default": 0,
|
|
"title": "Top K",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "LogProbConfig",
|
|
"type": "object"
|
|
},
|
|
"ToolDefinition": {
|
|
"properties": {
|
|
"tool_name": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/BuiltinTool"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"title": "Tool Name"
|
|
},
|
|
"description": {
|
|
"title": "Description",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"input_schema": {
|
|
"title": "Input Schema",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
},
|
|
"output_schema": {
|
|
"title": "Output Schema",
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"tool_name"
|
|
],
|
|
"title": "ToolDefinition",
|
|
"type": "object"
|
|
},
|
|
"MetricInResponse": {
|
|
"description": "A metric value included in API responses.",
|
|
"properties": {
|
|
"metric": {
|
|
"title": "Metric",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
}
|
|
],
|
|
"title": "Value"
|
|
},
|
|
"unit": {
|
|
"title": "Unit",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"metric",
|
|
"value"
|
|
],
|
|
"title": "MetricInResponse",
|
|
"type": "object"
|
|
},
|
|
"ChatCompletionResponseEventType": {
|
|
"description": "Types of events that can occur during chat completion.",
|
|
"enum": [
|
|
"start",
|
|
"complete",
|
|
"progress"
|
|
],
|
|
"title": "ChatCompletionResponseEventType",
|
|
"type": "string"
|
|
},
|
|
"RLHFAlgorithm": {
|
|
"description": "Available reinforcement learning from human feedback algorithms.",
|
|
"enum": [
|
|
"dpo"
|
|
],
|
|
"title": "RLHFAlgorithm",
|
|
"type": "string"
|
|
},
|
|
"FilteringFunction": {
|
|
"description": "The type of filtering function.",
|
|
"enum": [
|
|
"none",
|
|
"random",
|
|
"top_k",
|
|
"top_p",
|
|
"top_k_top_p",
|
|
"sigmoid"
|
|
],
|
|
"title": "FilteringFunction",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"responses": {
|
|
"BadRequest400": {
|
|
"description": "The request was invalid or malformed",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
},
|
|
"example": {
|
|
"status": 400,
|
|
"title": "Bad Request",
|
|
"detail": "The request was invalid or malformed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"TooManyRequests429": {
|
|
"description": "The client has sent too many requests in a given amount of time",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
},
|
|
"example": {
|
|
"status": 429,
|
|
"title": "Too Many Requests",
|
|
"detail": "You have exceeded the rate limit. Please try again later."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"InternalServerError500": {
|
|
"description": "The server encountered an unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
},
|
|
"example": {
|
|
"status": 500,
|
|
"title": "Internal Server Error",
|
|
"detail": "An unexpected error occurred. Our team has been notified."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"DefaultError": {
|
|
"description": "An unexpected error occurred",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |